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 boolean	canCreateSampledTables(ConnectorSession session) Returns true if this catalog supports creation of sampled tables
default void	createTable(ConnectorSession session, ConnectorTableMetadata tableMetadata) Creates a table using the specified table metadata.
default void	createView(ConnectorSession session, SchemaTableName viewName, String viewData, boolean replace) Create the specified view.
default void	dropTable(ConnectorSession session, ConnectorTableHandle tableHandle) Drops the specified table
default void	dropView(ConnectorSession session, SchemaTableName viewName) Drop the specified view.
default void	finishCreateTable(ConnectorSession session, ConnectorOutputTableHandle tableHandle, Collection<io.airlift.slice.Slice> fragments) 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 void	finishInsert(ConnectorSession session, ConnectorInsertTableHandle insertHandle, Collection<io.airlift.slice.Slice> fragments) Finish insert query
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<ConnectorNewTableLayout>	getNewTableLayout(ConnectorSession session, ConnectorTableMetadata tableMetadata) Get the physical layout for a new table.
default ColumnHandle	getSampleWeightColumnHandle(ConnectorSession session, ConnectorTableHandle tableHandle) Returns the handle for the sample weight column, or null if the table does not contain sampled data.
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.
ConnectorTableLayout	getTableLayout(ConnectorSession session, ConnectorTableLayoutHandle handle)
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 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	grantTablePrivileges(ConnectorSession session, SchemaTableName tableName, Set<Privilege> privileges, String grantee, boolean grantOption) Grants the specified privilege to the specified user on the specified table
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.
List<SchemaTableName>	listTables(ConnectorSession session, String schemaNameOrNull) List table names, possibly filtered by schema.
default List<SchemaTableName>	listViews(ConnectorSession session, String schemaNameOrNull) List view names, possibly filtered by schema.
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	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 boolean	supportsMetadataDelete(ConnectorSession session, ConnectorTableHandle tableHandle, ConnectorTableLayoutHandle tableLayoutHandle)

Method Detail

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.

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)

getTableMetadata

ConnectorTableMetadata getTableMetadata(ConnectorSession session,
                                        ConnectorTableHandle table)

Return the metadata for the specified table handle.

Throws:

RuntimeException - if table handle is no longer valid

listTables

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

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

getSampleWeightColumnHandle

default ColumnHandle getSampleWeightColumnHandle(ConnectorSession session,
                                                 ConnectorTableHandle tableHandle)

Returns the handle for the sample weight column, or null if the table does not contain sampled data.

Throws:

RuntimeException - if the table handle is no longer valid

canCreateSampledTables

default boolean canCreateSampledTables(ConnectorSession session)

Returns true if this catalog supports creation of sampled tables

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

listTableColumns

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

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

createTable

default void createTable(ConnectorSession session,
                         ConnectorTableMetadata tableMetadata)

Creates a table using the specified table metadata.

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

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

getNewTableLayout

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

Get the physical layout for a new table.

beginCreateTable

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

Begin the atomic creation of a table with data.

finishCreateTable

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

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

beginInsert

default ConnectorInsertTableHandle beginInsert(ConnectorSession session,
                                               ConnectorTableHandle tableHandle)

Begin insert query

finishInsert

default void finishInsert(ConnectorSession session,
                          ConnectorInsertTableHandle insertHandle,
                          Collection<io.airlift.slice.Slice> fragments)

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,
                        SchemaTableName viewName,
                        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

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

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

getViews

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

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

supportsMetadataDelete

default boolean supportsMetadataDelete(ConnectorSession session,
                                       ConnectorTableHandle tableHandle,
                                       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.

grantTablePrivileges

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

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