Package org.apache.polaris.persistence.relational.jdbc.models

Interface ModelEvent

All Superinterfaces:

Converter<org.apache.polaris.core.entity.EventEntity>

@PolarisImmutable
public interface ModelEvent
extends Converter<org.apache.polaris.core.entity.EventEntity>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_PROPERTIES
static final List<String>	ALL_COLUMNS
static final String	CATALOG_ID
static final ModelEvent	CONVERTER	Dummy instance to be used as a Converter when calling #fromResultSet().
static final String	EVENT_ID
static final String	EVENT_TYPE
static final String	LEGACY_REALM_SCOPED_CATALOG_ID	Legacy sentinel stored in events.catalog_id for events that are not catalog-scoped on schema versions < 5, where the column is NOT NULL.
static final String	PRINCIPAL_NAME
static final String	REQUEST_ID
static final String	RESOURCE_IDENTIFIER
static final String	RESOURCE_TYPE
static final String	TABLE_NAME
static final String	TIMESTAMP_MS

Method Summary

Modifier and Type	Method	Description
static ModelEvent	fromEvent(org.apache.polaris.core.entity.EventEntity event, int schemaVersion)
default org.apache.polaris.core.entity.EventEntity	fromResultSet(ResultSet rs)	Converts a ResultSet to model.
String	getAdditionalProperties()
@Nullable String	getCatalogId()
String	getEventId()
String	getEventType()
@Nullable String	getPrincipalName()
@Nullable String	getRequestId()
String	getResourceIdentifier()
org.apache.polaris.core.entity.EventEntity.ResourceType	getResourceType()
long	getTimestampMs()
static org.apache.polaris.core.entity.EventEntity	toEvent(ModelEvent model)
default Map<String,Object>	toMap(DatabaseType databaseType)	Convert a model into a Map with keys as snake case names, and values as values of member of model obj.

Methods inherited from interface org.apache.polaris.persistence.relational.jdbc.models.Converter

toJsonbPGobject

Field Details

TABLE_NAME

static final String TABLE_NAME

See Also:

• Constant Field Values

CATALOG_ID

static final String CATALOG_ID

See Also:

• Constant Field Values

EVENT_ID

static final String EVENT_ID

See Also:

• Constant Field Values

REQUEST_ID

static final String REQUEST_ID

See Also:

• Constant Field Values

EVENT_TYPE

static final String EVENT_TYPE

See Also:

• Constant Field Values

TIMESTAMP_MS

static final String TIMESTAMP_MS

See Also:

• Constant Field Values

PRINCIPAL_NAME

static final String PRINCIPAL_NAME

See Also:

• Constant Field Values

RESOURCE_TYPE

static final String RESOURCE_TYPE

See Also:

• Constant Field Values

RESOURCE_IDENTIFIER

static final String RESOURCE_IDENTIFIER

See Also:

• Constant Field Values

ADDITIONAL_PROPERTIES

static final String ADDITIONAL_PROPERTIES

See Also:

• Constant Field Values

LEGACY_REALM_SCOPED_CATALOG_ID

static final String LEGACY_REALM_SCOPED_CATALOG_ID

Legacy sentinel stored in events.catalog_id for events that are not catalog-scoped on schema versions < 5, where the column is NOT NULL. Never exposed outside the JDBC layer: fromEvent(EventEntity, int) substitutes it for a null catalog id on pre-v5 schemas, and fromResultSet(java.sql.ResultSet) coalesces it back to null on read.

Because fromResultSet(java.sql.ResultSet) cannot know which schema version a row was written under, the coalescing is unconditional, so this string remains reserved on all schema versions: a catalog literally named __realm__ would have its events read back as realm-scoped.

See Also:

• Constant Field Values

ALL_COLUMNS

static final List<String> ALL_COLUMNS

CONVERTER

static final ModelEvent CONVERTER

Dummy instance to be used as a Converter when calling #fromResultSet().

FIXME: fromResultSet() is a factory method and should be static or moved to a factory class.

Method Details

getCatalogId

@Nullable String getCatalogId()

getEventId

String getEventId()

getRequestId

@Nullable String getRequestId()

getEventType

String getEventType()

getTimestampMs

long getTimestampMs()

getPrincipalName

@Nullable String getPrincipalName()

getResourceType

org.apache.polaris.core.entity.EventEntity.ResourceType getResourceType()

getResourceIdentifier

String getResourceIdentifier()

getAdditionalProperties

String getAdditionalProperties()

fromResultSet

default org.apache.polaris.core.entity.EventEntity fromResultSet(ResultSet rs)
                                                          throws SQLException

Description copied from interface: Converter

Converts a ResultSet to model.

Specified by:

fromResultSet in interface Converter<org.apache.polaris.core.entity.EventEntity>

Parameters:

rs - : ResultSet from JDBC.

Returns:

the corresponding business entity

Throws:

SQLException - : Exception while fetching from ResultSet.

toMap

default Map<String,Object> toMap(DatabaseType databaseType)

Description copied from interface: Converter

Convert a model into a Map with keys as snake case names, and values as values of member of model obj.

Specified by:

toMap in interface Converter<org.apache.polaris.core.entity.EventEntity>

fromEvent

static ModelEvent fromEvent(org.apache.polaris.core.entity.EventEntity event,
 int schemaVersion)

toEvent

static org.apache.polaris.core.entity.EventEntity toEvent(ModelEvent model)