com.facebook.presto.spi.connector

Interface ConnectorMetadata

All Known Implementing Classes:

ClassLoaderSafeConnectorMetadata

public interface ConnectorMetadata

Method Summary

Modifier and Type	Method and Description
default void	addColumn(ConnectorSession session, ConnectorTableHandle tableHandle, ColumnMetadata column) Add the specified column
default ConnectorOutputTableHandle	beginCreateTable(ConnectorSession session, ConnectorTableMetadata tableMetadata, Optional<ConnectorNewTableLayout> layout) Begin the atomic creation of a table with data.
default ConnectorTableHandle	beginDelete(ConnectorSession session, ConnectorTableHandle tableHandle) Begin delete query
default ConnectorInsertTableHandle	beginInsert(ConnectorSession session, ConnectorTableHandle tableHandle) Begin insert query
default void	beginQuery(ConnectorSession session) Start a SELECT/UPDATE/INSERT/DELETE query.
default ConnectorInsertTableHandle	beginRefreshMaterializedView(ConnectorSession session, ConnectorTableHandle tableHandle) Begin refresh materialized view
default ConnectorTableHandle	beginStatisticsCollection(ConnectorSession session, ConnectorTableHandle tableHandle) Begin statistics collection
default void	cleanupQuery(ConnectorSession session) Cleanup after a SELECT/UPDATE/INSERT/DELETE query.
default CompletableFuture<Void>	commitPageSinkAsync(ConnectorSession session, ConnectorInsertTableHandle tableHandle, Collection<io.airlift.slice.Slice> fragments) Commits page sink for table insertion.
default CompletableFuture<Void>	commitPageSinkAsync(ConnectorSession session, ConnectorOutputTableHandle tableHandle, Collection<io.airlift.slice.Slice> fragments) Commits page sink for table creation.
default void	createMaterializedView(ConnectorSession session, ConnectorTableMetadata viewMetadata, ConnectorMaterializedViewDefinition viewDefinition, boolean ignoreExisting) Create the specified materialized view.
default void	createRole(ConnectorSession session, String role, Optional<PrestoPrincipal> grantor) Creates the specified role.
default void	createSchema(ConnectorSession session, String schemaName, Map<String,Object> properties) Creates a schema.
default void	createTable(ConnectorSession session, ConnectorTableMetadata tableMetadata, boolean ignoreExisting) Creates a table using the specified table metadata.
default ConnectorTableHandle	createTemporaryTable(ConnectorSession session, List<ColumnMetadata> columns, Optional<ConnectorPartitioningMetadata> partitioningMetadata) Creates a temporary table with optional partitioning requirements.
default void	createView(ConnectorSession session, ConnectorTableMetadata viewMetadata, String viewData, boolean replace) Create the specified view.
default void	doMetadataUpdateCleanup(QueryId queryId)
default void	dropColumn(ConnectorSession session, ConnectorTableHandle tableHandle, ColumnHandle column) Drop the specified column
default void	dropMaterializedView(ConnectorSession session, SchemaTableName viewName) Drop the specified materialized view.
default void	dropRole(ConnectorSession session, String role) Drops the specified role.
default void	dropSchema(ConnectorSession session, String schemaName) Drops the specified schema.
default void	dropTable(ConnectorSession session, ConnectorTableHandle tableHandle) Drops the specified table
default void	dropView(ConnectorSession session, SchemaTableName viewName) Drop the specified view.
default Optional<ConnectorOutputMetadata>	finishCreateTable(ConnectorSession session, ConnectorOutputTableHandle tableHandle, Collection<io.airlift.slice.Slice> fragments, Collection<ComputedStatistics> computedStatistics) Finish a table creation with data after the data is written.
default void	finishDelete(ConnectorSession session, ConnectorTableHandle tableHandle, Collection<io.airlift.slice.Slice> fragments) Finish delete query
default Optional<ConnectorOutputMetadata>	finishInsert(ConnectorSession session, ConnectorInsertTableHandle insertHandle, Collection<io.airlift.slice.Slice> fragments, Collection<ComputedStatistics> computedStatistics) Finish insert query
default Optional<ConnectorOutputMetadata>	finishRefreshMaterializedView(ConnectorSession session, ConnectorInsertTableHandle insertHandle, Collection<io.airlift.slice.Slice> fragments, Collection<ComputedStatistics> computedStatistics) Finish refresh materialized view
default void	finishStatisticsCollection(ConnectorSession session, ConnectorTableHandle tableHandle, Collection<ComputedStatistics> computedStatistics) Finish statistics collection
default ConnectorTableLayoutHandle	getAlternativeLayoutHandle(ConnectorSession session, ConnectorTableLayoutHandle tableLayoutHandle, ConnectorPartitioningHandle partitioningHandle) Return a table layout handle whose partitioning is converted to the provided partitioning handle, but otherwise identical to the provided table layout handle.
Map<String,ColumnHandle>	getColumnHandles(ConnectorSession session, ConnectorTableHandle tableHandle) Gets all of the columns on the specified table, or an empty map if the columns can not be enumerated.
ColumnMetadata	getColumnMetadata(ConnectorSession session, ConnectorTableHandle tableHandle, ColumnHandle columnHandle) Gets the metadata for the specified table column.
default Optional<ConnectorPartitioningHandle>	getCommonPartitioningHandle(ConnectorSession session, ConnectorPartitioningHandle left, ConnectorPartitioningHandle right) Deprecated.
default Optional<Object>	getInfo(ConnectorTableLayoutHandle layoutHandle) Return the connector-specific metadata for the specified table layout.
default Optional<ConnectorNewTableLayout>	getInsertLayout(ConnectorSession session, ConnectorTableHandle tableHandle) Get the physical layout for a inserting into an existing table.
default Optional<ConnectorMaterializedViewDefinition>	getMaterializedView(ConnectorSession session, SchemaTableName viewName) Gets the materialized view data for the specified materialized view name.
default MaterializedViewStatus	getMaterializedViewStatus(ConnectorSession session, SchemaTableName materializedViewName)
default MaterializedViewStatus	getMaterializedViewStatus(ConnectorSession session, SchemaTableName materializedViewName, TupleDomain<String> baseQueryDomain) Get the materialized view status to inform the engine how much data has been materialized in the view
default List<ConnectorMetadataUpdateHandle>	getMetadataUpdateResults(List<ConnectorMetadataUpdateHandle> metadataUpdateRequests, QueryId queryId) Handles metadata update requests and sends the results back to worker
default Optional<ConnectorNewTableLayout>	getNewTableLayout(ConnectorSession session, ConnectorTableMetadata tableMetadata) Get the physical layout for a new table.
default ConnectorPartitioningHandle	getPartitioningHandleForExchange(ConnectorSession session, int partitionCount, List<Type> partitionTypes) Provides partitioning handle for exchange.
default Optional<ConnectorNewTableLayout>	getPreferredShuffleLayoutForInsert(ConnectorSession session, ConnectorTableHandle tableHandle) A connector can have preferred shuffle layout for table write.
default Optional<ConnectorNewTableLayout>	getPreferredShuffleLayoutForNewTable(ConnectorSession session, ConnectorTableMetadata tableMetadata) A connector can have preferred shuffle layout for table write.
default Optional<List<SchemaTableName>>	getReferencedMaterializedViews(ConnectorSession session, SchemaTableName tableName) Gets the referenced materialized views for a give table
default TableStatisticsMetadata	getStatisticsCollectionMetadata(ConnectorSession session, ConnectorTableMetadata tableMetadata) Describe statistics that must be collected during a statistics collection
default TableStatisticsMetadata	getStatisticsCollectionMetadataForWrite(ConnectorSession session, ConnectorTableMetadata tableMetadata) Describes statistics that must be collected during a write.
default Optional<SystemTable>	getSystemTable(ConnectorSession session, SchemaTableName tableName) Returns the system table for the specified table name, if one exists.
ConnectorTableHandle	getTableHandle(ConnectorSession session, SchemaTableName tableName) Returns a table handle for the specified table name, or null if the connector does not contain the table.
default ConnectorTableHandle	getTableHandleForStatisticsCollection(ConnectorSession session, SchemaTableName tableName, Map<String,Object> analyzeProperties) Returns a table handle for the specified table name, or null if the connector does not contain the table.
ConnectorTableLayout	getTableLayout(ConnectorSession session, ConnectorTableLayoutHandle handle)
default TableLayoutFilterCoverage	getTableLayoutFilterCoverage(ConnectorTableLayoutHandle tableHandle, Set<String> relevantPartitionColumns)
List<ConnectorTableLayoutResult>	getTableLayouts(ConnectorSession session, ConnectorTableHandle table, Constraint<ColumnHandle> constraint, Optional<Set<ColumnHandle>> desiredColumns) Return a list of table layouts that satisfy the given constraint.
ConnectorTableMetadata	getTableMetadata(ConnectorSession session, ConnectorTableHandle table) Return the metadata for the specified table handle.
default TableStatistics	getTableStatistics(ConnectorSession session, ConnectorTableHandle tableHandle, Optional<ConnectorTableLayoutHandle> tableLayoutHandle, List<ColumnHandle> columnHandles, Constraint<ColumnHandle> constraint) Get statistics for table for given columns and filtering constraint.
default ColumnHandle	getUpdateRowIdColumnHandle(ConnectorSession session, ConnectorTableHandle tableHandle) Get the column handle that will generate row IDs for the delete operation.
default Map<SchemaTableName,ConnectorViewDefinition>	getViews(ConnectorSession session, SchemaTablePrefix prefix) Gets the view data for views that match the specified table prefix.
default void	grantRoles(ConnectorSession connectorSession, Set<String> roles, Set<PrestoPrincipal> grantees, boolean withAdminOption, Optional<PrestoPrincipal> grantor) Grants the specified roles to the specified grantees
default void	grantTablePrivileges(ConnectorSession session, SchemaTableName tableName, Set<Privilege> privileges, PrestoPrincipal grantee, boolean grantOption) Grants the specified privilege to the specified user on the specified table
default boolean	isLegacyGetLayoutSupported(ConnectorSession session, ConnectorTableHandle tableHandle) Deprecated.
default boolean	isRefinedPartitioningOver(ConnectorSession session, ConnectorPartitioningHandle left, ConnectorPartitioningHandle right) Partitioning a = {a_1, ...
default Set<RoleGrant>	listApplicableRoles(ConnectorSession session, PrestoPrincipal principal) List applicable roles, including the transitive grants, for the specified principal
default Set<String>	listEnabledRoles(ConnectorSession session) List applicable roles, including the transitive grants, in given session
default Set<RoleGrant>	listRoleGrants(ConnectorSession session, PrestoPrincipal principal) List role grants for a given principal, not recursively.
default Set<String>	listRoles(ConnectorSession session) List available roles.
List<String>	listSchemaNames(ConnectorSession session) Returns the schemas provided by this connector.
Map<SchemaTableName,List<ColumnMetadata>>	listTableColumns(ConnectorSession session, SchemaTablePrefix prefix) Gets the metadata for all columns that match the specified table prefix.
default List<GrantInfo>	listTablePrivileges(ConnectorSession session, SchemaTablePrefix prefix) List the table privileges granted to the specified grantee for the tables that have the specified prefix considering the selected session role
default List<SchemaTableName>	listTables(ConnectorSession session, Optional<String> schemaName) List table names, possibly filtered by schema.
default List<SchemaTableName>	listTables(ConnectorSession session, String schemaNameOrNull) Deprecated. replaced by listTables(ConnectorSession, Optional)
default List<SchemaTableName>	listViews(ConnectorSession session, Optional<String> schemaName)
default List<SchemaTableName>	listViews(ConnectorSession session, String schemaNameOrNull) Deprecated. replaced by listViews(ConnectorSession, Optional)
default OptionalLong	metadataDelete(ConnectorSession session, ConnectorTableHandle tableHandle, ConnectorTableLayoutHandle tableLayoutHandle) Delete the provided table layout
default void	renameColumn(ConnectorSession session, ConnectorTableHandle tableHandle, ColumnHandle source, String target) Rename the specified column
default void	renameSchema(ConnectorSession session, String source, String target) Renames the specified schema.
default void	renameTable(ConnectorSession session, ConnectorTableHandle tableHandle, SchemaTableName newTableName) Rename the specified table
default Optional<ConnectorResolvedIndex>	resolveIndex(ConnectorSession session, ConnectorTableHandle tableHandle, Set<ColumnHandle> indexableColumns, Set<ColumnHandle> outputColumns, TupleDomain<ColumnHandle> tupleDomain) Try to locate a table index that can lookup results by indexableColumns and provide the requested outputColumns.
default void	revokeRoles(ConnectorSession connectorSession, Set<String> roles, Set<PrestoPrincipal> grantees, boolean adminOptionFor, Optional<PrestoPrincipal> grantor) Revokes the specified roles from the specified grantees
default void	revokeTablePrivileges(ConnectorSession session, SchemaTableName tableName, Set<Privilege> privileges, PrestoPrincipal grantee, boolean grantOption) Revokes the specified privilege on the specified table from the specified user
default boolean	schemaExists(ConnectorSession session, String schemaName) Checks if a schema exists.
default boolean	supportsMetadataDelete(ConnectorSession session, ConnectorTableHandle tableHandle, Optional<ConnectorTableLayoutHandle> tableLayoutHandle)
default TupleDomain<ColumnHandle>	toExplainIOConstraints(ConnectorSession session, ConnectorTableHandle tableHandle, TupleDomain<ColumnHandle> constraints) Returns a TupleDomain of constraints that is suitable for ExplainIO
default void	truncateTable(ConnectorSession session, ConnectorTableHandle tableHandle) Truncates the specified table

Method Detail

schemaExists

default boolean schemaExists(ConnectorSession session,
                             String schemaName)

Checks if a schema exists. The connector may have schemas that exist but are not enumerable via listSchemaNames(com.facebook.presto.spi.ConnectorSession).

listSchemaNames

List<String> listSchemaNames(ConnectorSession session)

Returns the schemas provided by this connector.

getTableHandle

ConnectorTableHandle getTableHandle(ConnectorSession session,
                                    SchemaTableName tableName)

Returns a table handle for the specified table name, or null if the connector does not contain the table.

getTableHandleForStatisticsCollection

default ConnectorTableHandle getTableHandleForStatisticsCollection(ConnectorSession session,
                                                                   SchemaTableName tableName,
                                                                   Map<String,Object> analyzeProperties)

Returns a table handle for the specified table name, or null if the connector does not contain the table. The returned table handle can contain information in analyzeProperties.

getSystemTable

default Optional<SystemTable> getSystemTable(ConnectorSession session,
                                             SchemaTableName tableName)

Returns the system table for the specified table name, if one exists. The system tables handled via getSystemTable(com.facebook.presto.spi.ConnectorSession, com.facebook.presto.spi.SchemaTableName) differ form those returned by Connector.getSystemTables(). The former mechanism allows dynamic resolution of system tables, while the latter is based on static list of system tables built during startup.

getTableLayouts

List<ConnectorTableLayoutResult> getTableLayouts(ConnectorSession session,
                                                 ConnectorTableHandle table,
                                                 Constraint<ColumnHandle> constraint,
                                                 Optional<Set<ColumnHandle>> desiredColumns)

Return a list of table layouts that satisfy the given constraint.

For each layout, connectors must return an "unenforced constraint" representing the part of the constraint summary that isn't guaranteed by the layout.

getTableLayout

ConnectorTableLayout getTableLayout(ConnectorSession session,
                                    ConnectorTableLayoutHandle handle)

getAlternativeLayoutHandle

default ConnectorTableLayoutHandle getAlternativeLayoutHandle(ConnectorSession session,
                                                              ConnectorTableLayoutHandle tableLayoutHandle,
                                                              ConnectorPartitioningHandle partitioningHandle)

Return a table layout handle whose partitioning is converted to the provided partitioning handle, but otherwise identical to the provided table layout handle. The provided table layout handle must be one that the connector can transparently convert to from the original partitioning handle associated with the provided table layout handle, as promised by getCommonPartitioningHandle(com.facebook.presto.spi.ConnectorSession, com.facebook.presto.spi.connector.ConnectorPartitioningHandle, com.facebook.presto.spi.connector.ConnectorPartitioningHandle).

isLegacyGetLayoutSupported

@Deprecated
 @Experimental
default boolean isLegacyGetLayoutSupported(ConnectorSession session,
                                                                      ConnectorTableHandle tableHandle)

Deprecated.

Experimental: if true, the engine will invoke getLayout otherwise, getLayout will not be called.

getCommonPartitioningHandle

@Deprecated
default Optional<ConnectorPartitioningHandle> getCommonPartitioningHandle(ConnectorSession session,
                                                                                      ConnectorPartitioningHandle left,
                                                                                      ConnectorPartitioningHandle right)

Deprecated.

Return a partitioning handle which the connector can transparently convert both left and right into.

isRefinedPartitioningOver

default boolean isRefinedPartitioningOver(ConnectorSession session,
                                          ConnectorPartitioningHandle left,
                                          ConnectorPartitioningHandle right)

Partitioning a = {a_1, ... a_n} is considered as a refined partitioning over partitioning b = {b_1, ... b_m} if:

• n >= m
• For every partition b_i in partitioning b, the rows it contains is the same as union of a set of partitions a_{i_1}, a_{i_2}, ... a_{i_k} in partitioning a, i.e.

  b_i = a_{i_1} + a_{i_2} + ... + a_{i_k}

• Connector can transparently convert partitioning a to partitioning b associated with the provided table layout handle.

For example, consider two partitioning over order table:

• partitioning a has 256 partitions by orderkey % 256
• partitioning b has 128 partitions by orderkey % 128

Partitioning a is a refined partitioning over b if Connector supports transparently convert a to b.

Refined-over relation is reflexive.

This SPI is unstable and subject to change in the future.

getPartitioningHandleForExchange

default ConnectorPartitioningHandle getPartitioningHandleForExchange(ConnectorSession session,
                                                                     int partitionCount,
                                                                     List<Type> partitionTypes)

Provides partitioning handle for exchange.

getTableMetadata

ConnectorTableMetadata getTableMetadata(ConnectorSession session,
                                        ConnectorTableHandle table)

Return the metadata for the specified table handle.

Throws:

RuntimeException - if table handle is no longer valid

getInfo

default Optional<Object> getInfo(ConnectorTableLayoutHandle layoutHandle)

Return the connector-specific metadata for the specified table layout. This is the object that is passed to the event listener framework.

Throws:

RuntimeException - if table handle is no longer valid

listTables

@Deprecated
default List<SchemaTableName> listTables(ConnectorSession session,
                                                     String schemaNameOrNull)

Deprecated. replaced by listTables(ConnectorSession, Optional)

List table names, possibly filtered by schema. An empty list is returned if none match.

listTables

default List<SchemaTableName> listTables(ConnectorSession session,
                                         Optional<String> schemaName)

List table names, possibly filtered by schema. An empty list is returned if none match.

getColumnHandles

Map<String,ColumnHandle> getColumnHandles(ConnectorSession session,
                                          ConnectorTableHandle tableHandle)

Gets all of the columns on the specified table, or an empty map if the columns can not be enumerated.

Throws:

RuntimeException - if table handle is no longer valid

getColumnMetadata

ColumnMetadata getColumnMetadata(ConnectorSession session,
                                 ConnectorTableHandle tableHandle,
                                 ColumnHandle columnHandle)

Gets the metadata for the specified table column.

Throws:

RuntimeException - if table or column handles are no longer valid

toExplainIOConstraints

default TupleDomain<ColumnHandle> toExplainIOConstraints(ConnectorSession session,
                                                         ConnectorTableHandle tableHandle,
                                                         TupleDomain<ColumnHandle> constraints)

Returns a TupleDomain of constraints that is suitable for ExplainIO

listTableColumns

Map<SchemaTableName,List<ColumnMetadata>> listTableColumns(ConnectorSession session,
                                                           SchemaTablePrefix prefix)

Gets the metadata for all columns that match the specified table prefix.

getTableStatistics

default TableStatistics getTableStatistics(ConnectorSession session,
                                           ConnectorTableHandle tableHandle,
                                           Optional<ConnectorTableLayoutHandle> tableLayoutHandle,
                                           List<ColumnHandle> columnHandles,
                                           Constraint<ColumnHandle> constraint)

Get statistics for table for given columns and filtering constraint.

createSchema

default void createSchema(ConnectorSession session,
                          String schemaName,
                          Map<String,Object> properties)

Creates a schema.

dropSchema

default void dropSchema(ConnectorSession session,
                        String schemaName)

Drops the specified schema.

Throws:

PrestoException - with SCHEMA_NOT_EMPTY if the schema is not empty

renameSchema

default void renameSchema(ConnectorSession session,
                          String source,
                          String target)

Renames the specified schema.

createTable

default void createTable(ConnectorSession session,
                         ConnectorTableMetadata tableMetadata,
                         boolean ignoreExisting)

Creates a table using the specified table metadata.

Throws:

PrestoException - with ALREADY_EXISTS if the table already exists and is not set

createTemporaryTable

default ConnectorTableHandle createTemporaryTable(ConnectorSession session,
                                                  List<ColumnMetadata> columns,
                                                  Optional<ConnectorPartitioningMetadata> partitioningMetadata)

Creates a temporary table with optional partitioning requirements. Temporary table might have different default storage format, compression scheme, replication factor, etc, and gets automatically dropped when the transaction ends.

This SPI is unstable and subject to change in the future.

dropTable

default void dropTable(ConnectorSession session,
                       ConnectorTableHandle tableHandle)

Drops the specified table

Throws:

RuntimeException - if the table can not be dropped or table handle is no longer valid

truncateTable

default void truncateTable(ConnectorSession session,
                           ConnectorTableHandle tableHandle)

Truncates the specified table

Throws:

RuntimeException - if the table cannot be truncated or table handle is no longer valid

renameTable

default void renameTable(ConnectorSession session,
                         ConnectorTableHandle tableHandle,
                         SchemaTableName newTableName)

Rename the specified table

addColumn

default void addColumn(ConnectorSession session,
                       ConnectorTableHandle tableHandle,
                       ColumnMetadata column)

Add the specified column

renameColumn

default void renameColumn(ConnectorSession session,
                          ConnectorTableHandle tableHandle,
                          ColumnHandle source,
                          String target)

Rename the specified column

dropColumn

default void dropColumn(ConnectorSession session,
                        ConnectorTableHandle tableHandle,
                        ColumnHandle column)

Drop the specified column

getNewTableLayout

default Optional<ConnectorNewTableLayout> getNewTableLayout(ConnectorSession session,
                                                            ConnectorTableMetadata tableMetadata)

Get the physical layout for a new table.

getPreferredShuffleLayoutForNewTable

@Experimental
default Optional<ConnectorNewTableLayout> getPreferredShuffleLayoutForNewTable(ConnectorSession session,
                                                                                             ConnectorTableMetadata tableMetadata)

A connector can have preferred shuffle layout for table write. For example, Hive connector might prefer to shuffle on partitioned columns for partitioned unbucketed table.

See Also:

getPreferredShuffleLayoutForInsert(com.facebook.presto.spi.ConnectorSession, com.facebook.presto.spi.ConnectorTableHandle)

getInsertLayout

default Optional<ConnectorNewTableLayout> getInsertLayout(ConnectorSession session,
                                                          ConnectorTableHandle tableHandle)

Get the physical layout for a inserting into an existing table.

getPreferredShuffleLayoutForInsert

@Experimental
default Optional<ConnectorNewTableLayout> getPreferredShuffleLayoutForInsert(ConnectorSession session,
                                                                                           ConnectorTableHandle tableHandle)

A connector can have preferred shuffle layout for table write. For example, Hive connector might prefer to shuffle on partitioned columns for partitioned unbucketed table.

See Also:

getPreferredShuffleLayoutForNewTable(com.facebook.presto.spi.ConnectorSession, com.facebook.presto.spi.ConnectorTableMetadata)

getStatisticsCollectionMetadataForWrite

default TableStatisticsMetadata getStatisticsCollectionMetadataForWrite(ConnectorSession session,
                                                                        ConnectorTableMetadata tableMetadata)

Describes statistics that must be collected during a write.

getStatisticsCollectionMetadata

default TableStatisticsMetadata getStatisticsCollectionMetadata(ConnectorSession session,
                                                                ConnectorTableMetadata tableMetadata)

Describe statistics that must be collected during a statistics collection

beginStatisticsCollection

default ConnectorTableHandle beginStatisticsCollection(ConnectorSession session,
                                                       ConnectorTableHandle tableHandle)

Begin statistics collection

finishStatisticsCollection

default void finishStatisticsCollection(ConnectorSession session,
                                        ConnectorTableHandle tableHandle,
                                        Collection<ComputedStatistics> computedStatistics)

Finish statistics collection

beginCreateTable

default ConnectorOutputTableHandle beginCreateTable(ConnectorSession session,
                                                    ConnectorTableMetadata tableMetadata,
                                                    Optional<ConnectorNewTableLayout> layout)

Begin the atomic creation of a table with data.

finishCreateTable

default Optional<ConnectorOutputMetadata> finishCreateTable(ConnectorSession session,
                                                            ConnectorOutputTableHandle tableHandle,
                                                            Collection<io.airlift.slice.Slice> fragments,
                                                            Collection<ComputedStatistics> computedStatistics)

Finish a table creation with data after the data is written.

beginQuery

default void beginQuery(ConnectorSession session)

Start a SELECT/UPDATE/INSERT/DELETE query. This notification is triggered after the planning phase completes.

cleanupQuery

default void cleanupQuery(ConnectorSession session)

Cleanup after a SELECT/UPDATE/INSERT/DELETE query. This is the very last notification after the query finishes, whether it succeeds or fails. An exception thrown in this method will not affect the result of the query.

beginInsert

default ConnectorInsertTableHandle beginInsert(ConnectorSession session,
                                               ConnectorTableHandle tableHandle)

Begin insert query

finishInsert

default Optional<ConnectorOutputMetadata> finishInsert(ConnectorSession session,
                                                       ConnectorInsertTableHandle insertHandle,
                                                       Collection<io.airlift.slice.Slice> fragments,
                                                       Collection<ComputedStatistics> computedStatistics)

Finish insert query

getUpdateRowIdColumnHandle

default ColumnHandle getUpdateRowIdColumnHandle(ConnectorSession session,
                                                ConnectorTableHandle tableHandle)

Get the column handle that will generate row IDs for the delete operation. These IDs will be passed to the deleteRows() method of the UpdatablePageSource that created them.

beginDelete

default ConnectorTableHandle beginDelete(ConnectorSession session,
                                         ConnectorTableHandle tableHandle)

Begin delete query

finishDelete

default void finishDelete(ConnectorSession session,
                          ConnectorTableHandle tableHandle,
                          Collection<io.airlift.slice.Slice> fragments)

Finish delete query

Parameters:

fragments - all fragments returned by UpdatablePageSource.finish()

createView

default void createView(ConnectorSession session,
                        ConnectorTableMetadata viewMetadata,
                        String viewData,
                        boolean replace)

Create the specified view. The data for the view is opaque to the connector.

dropView

default void dropView(ConnectorSession session,
                      SchemaTableName viewName)

Drop the specified view.

listViews

@Deprecated
default List<SchemaTableName> listViews(ConnectorSession session,
                                                    String schemaNameOrNull)

Deprecated. replaced by listViews(ConnectorSession, Optional)

List view names, possibly filtered by schema. An empty list is returned if none match.

listViews

default List<SchemaTableName> listViews(ConnectorSession session,
                                        Optional<String> schemaName)

getViews

default Map<SchemaTableName,ConnectorViewDefinition> getViews(ConnectorSession session,
                                                              SchemaTablePrefix prefix)

Gets the view data for views that match the specified table prefix.

getMaterializedView

default Optional<ConnectorMaterializedViewDefinition> getMaterializedView(ConnectorSession session,
                                                                          SchemaTableName viewName)

Gets the materialized view data for the specified materialized view name.

createMaterializedView

default void createMaterializedView(ConnectorSession session,
                                    ConnectorTableMetadata viewMetadata,
                                    ConnectorMaterializedViewDefinition viewDefinition,
                                    boolean ignoreExisting)

Create the specified materialized view. The data for the materialized view is opaque to the connector.

dropMaterializedView

default void dropMaterializedView(ConnectorSession session,
                                  SchemaTableName viewName)

Drop the specified materialized view.

getMaterializedViewStatus

default MaterializedViewStatus getMaterializedViewStatus(ConnectorSession session,
                                                         SchemaTableName materializedViewName,
                                                         TupleDomain<String> baseQueryDomain)

Get the materialized view status to inform the engine how much data has been materialized in the view

Parameters:

baseQueryDomain - The domain from which to consider missing partitions. For example, a query that selects a specific date range can consider only partitions from that range when determining view staleness.

getMaterializedViewStatus

default MaterializedViewStatus getMaterializedViewStatus(ConnectorSession session,
                                                         SchemaTableName materializedViewName)

beginRefreshMaterializedView

default ConnectorInsertTableHandle beginRefreshMaterializedView(ConnectorSession session,
                                                                ConnectorTableHandle tableHandle)

Begin refresh materialized view

finishRefreshMaterializedView

default Optional<ConnectorOutputMetadata> finishRefreshMaterializedView(ConnectorSession session,
                                                                        ConnectorInsertTableHandle insertHandle,
                                                                        Collection<io.airlift.slice.Slice> fragments,
                                                                        Collection<ComputedStatistics> computedStatistics)

Finish refresh materialized view

getReferencedMaterializedViews

default Optional<List<SchemaTableName>> getReferencedMaterializedViews(ConnectorSession session,
                                                                       SchemaTableName tableName)

Gets the referenced materialized views for a give table

supportsMetadataDelete

default boolean supportsMetadataDelete(ConnectorSession session,
                                       ConnectorTableHandle tableHandle,
                                       Optional<ConnectorTableLayoutHandle> tableLayoutHandle)

Returns:

whether delete without table scan is supported

metadataDelete

default OptionalLong metadataDelete(ConnectorSession session,
                                    ConnectorTableHandle tableHandle,
                                    ConnectorTableLayoutHandle tableLayoutHandle)

Delete the provided table layout

Returns:

number of rows deleted, or null for unknown

resolveIndex

default Optional<ConnectorResolvedIndex> resolveIndex(ConnectorSession session,
                                                      ConnectorTableHandle tableHandle,
                                                      Set<ColumnHandle> indexableColumns,
                                                      Set<ColumnHandle> outputColumns,
                                                      TupleDomain<ColumnHandle> tupleDomain)

Try to locate a table index that can lookup results by indexableColumns and provide the requested outputColumns.

createRole

default void createRole(ConnectorSession session,
                        String role,
                        Optional<PrestoPrincipal> grantor)

Creates the specified role.

Parameters:

grantor - represents the principal specified by WITH ADMIN statement

dropRole

default void dropRole(ConnectorSession session,
                      String role)

Drops the specified role.

listRoles

default Set<String> listRoles(ConnectorSession session)

List available roles.

listRoleGrants

default Set<RoleGrant> listRoleGrants(ConnectorSession session,
                                      PrestoPrincipal principal)

List role grants for a given principal, not recursively.

grantRoles

default void grantRoles(ConnectorSession connectorSession,
                        Set<String> roles,
                        Set<PrestoPrincipal> grantees,
                        boolean withAdminOption,
                        Optional<PrestoPrincipal> grantor)

Grants the specified roles to the specified grantees

Parameters:

grantor - represents the principal specified by GRANTED BY statement

revokeRoles

default void revokeRoles(ConnectorSession connectorSession,
                         Set<String> roles,
                         Set<PrestoPrincipal> grantees,
                         boolean adminOptionFor,
                         Optional<PrestoPrincipal> grantor)

Revokes the specified roles from the specified grantees

Parameters:

grantor - represents the principal specified by GRANTED BY statement

listApplicableRoles

default Set<RoleGrant> listApplicableRoles(ConnectorSession session,
                                           PrestoPrincipal principal)

List applicable roles, including the transitive grants, for the specified principal

listEnabledRoles

default Set<String> listEnabledRoles(ConnectorSession session)

List applicable roles, including the transitive grants, in given session

grantTablePrivileges

default void grantTablePrivileges(ConnectorSession session,
                                  SchemaTableName tableName,
                                  Set<Privilege> privileges,
                                  PrestoPrincipal grantee,
                                  boolean grantOption)

Grants the specified privilege to the specified user on the specified table

revokeTablePrivileges

default void revokeTablePrivileges(ConnectorSession session,
                                   SchemaTableName tableName,
                                   Set<Privilege> privileges,
                                   PrestoPrincipal grantee,
                                   boolean grantOption)

Revokes the specified privilege on the specified table from the specified user

listTablePrivileges

default List<GrantInfo> listTablePrivileges(ConnectorSession session,
                                            SchemaTablePrefix prefix)

List the table privileges granted to the specified grantee for the tables that have the specified prefix considering the selected session role

commitPageSinkAsync

@Experimental
default CompletableFuture<Void> commitPageSinkAsync(ConnectorSession session,
                                                                  ConnectorOutputTableHandle tableHandle,
                                                                  Collection<io.airlift.slice.Slice> fragments)

Commits page sink for table creation. To enable recoverable grouped execution, it is required that output connector supports page sink commit. This method is unstable and subject to change in the future.

commitPageSinkAsync

@Experimental
default CompletableFuture<Void> commitPageSinkAsync(ConnectorSession session,
                                                                  ConnectorInsertTableHandle tableHandle,
                                                                  Collection<io.airlift.slice.Slice> fragments)

Commits page sink for table insertion. To enable recoverable grouped execution, it is required that output connector supports page sink commit. This method is unstable and subject to change in the future.

getMetadataUpdateResults

default List<ConnectorMetadataUpdateHandle> getMetadataUpdateResults(List<ConnectorMetadataUpdateHandle> metadataUpdateRequests,
                                                                     QueryId queryId)

Handles metadata update requests and sends the results back to worker

doMetadataUpdateCleanup

default void doMetadataUpdateCleanup(QueryId queryId)

getTableLayoutFilterCoverage

default TableLayoutFilterCoverage getTableLayoutFilterCoverage(ConnectorTableLayoutHandle tableHandle,
                                                               Set<String> relevantPartitionColumns)