io.prestosql.metadata

Interface Metadata

All Known Implementing Classes:

MetadataManager

public interface Metadata

Method Summary

Modifier and Type	Method and Description
void	addColumn(Session session, TableHandle tableHandle, ColumnMetadata column) Add the specified column to the table.
void	addFunctions(List<? extends SqlFunction> functions)
Optional<ConstraintApplicationResult<TableHandle>>	applyFilter(Session session, TableHandle table, Constraint constraint)
Optional<LimitApplicationResult<TableHandle>>	applyLimit(Session session, TableHandle table, long limit)
Optional<TableHandle>	applySample(Session session, TableHandle table, SampleType sampleType, double sampleRatio)
OutputTableHandle	beginCreateTable(Session session, String catalogName, ConnectorTableMetadata tableMetadata, Optional<NewTableLayout> layout) Begin the atomic creation of a table with data.
TableHandle	beginDelete(Session session, TableHandle tableHandle) Begin delete query
InsertTableHandle	beginInsert(Session session, TableHandle tableHandle) Begin insert query
void	beginQuery(Session session, Set<CatalogName> connectors) Start a SELECT/UPDATE/INSERT/DELETE query
AnalyzeTableHandle	beginStatisticsCollection(Session session, TableHandle tableHandle) Begin statistics collection
boolean	catalogExists(Session session, String catalogName)
void	cleanupQuery(Session session) Cleanup after a query.
void	createRole(Session session, String role, Optional<PrestoPrincipal> grantor, String catalog) Creates the specified role in the specified catalog.
void	createSchema(Session session, CatalogSchemaName schema, Map<String,Object> properties) Creates a schema.
void	createTable(Session session, String catalogName, ConnectorTableMetadata tableMetadata, boolean ignoreExisting) Creates a table using the specified table metadata.
void	createView(Session session, QualifiedObjectName viewName, String viewData, boolean replace) Creates the specified view with the specified view definition.
void	dropColumn(Session session, TableHandle tableHandle, ColumnHandle column) Drop the specified column.
void	dropRole(Session session, String role, String catalog) Drops the specified role in the specified catalog.
void	dropSchema(Session session, CatalogSchemaName schema) Drops the specified schema.
void	dropTable(Session session, TableHandle tableHandle) Drops the specified table
void	dropView(Session session, QualifiedObjectName viewName) Drops the specified view.
Optional<ConnectorOutputMetadata>	finishCreateTable(Session session, OutputTableHandle tableHandle, Collection<io.airlift.slice.Slice> fragments, Collection<ComputedStatistics> computedStatistics) Finish a table creation with data after the data is written.
void	finishDelete(Session session, TableHandle tableHandle, Collection<io.airlift.slice.Slice> fragments) Finish delete query
Optional<ConnectorOutputMetadata>	finishInsert(Session session, InsertTableHandle tableHandle, Collection<io.airlift.slice.Slice> fragments, Collection<ComputedStatistics> computedStatistics) Finish insert query
void	finishStatisticsCollection(Session session, AnalyzeTableHandle tableHandle, Collection<ComputedStatistics> computedStatistics) Finish statistics collection
AnalyzePropertyManager	getAnalyzePropertyManager()
BlockEncodingSerde	getBlockEncodingSerde()
Optional<CatalogName>	getCatalogHandle(Session session, String catalogName) Returns a connector id for the specified catalog name.
Map<String,CatalogName>	getCatalogNames(Session session) Gets all the loaded catalogs
Map<String,ColumnHandle>	getColumnHandles(Session session, TableHandle tableHandle) Gets all of the columns on the specified table, or an empty map if the columns can not be enumerated.
ColumnMetadata	getColumnMetadata(Session session, TableHandle tableHandle, ColumnHandle columnHandle) Gets the metadata for the specified table column.
ColumnPropertyManager	getColumnPropertyManager()
Optional<PartitioningHandle>	getCommonPartitioning(Session session, PartitioningHandle left, PartitioningHandle right) Return a partitioning handle which the connector can transparently convert both left and right into.
Set<ConnectorCapabilities>	getConnectorCapabilities(Session session, CatalogName catalogName)
FunctionRegistry	getFunctionRegistry()
Optional<Object>	getInfo(Session session, TableHandle handle)
Optional<NewTableLayout>	getInsertLayout(Session session, TableHandle target)
Optional<TableLayoutResult>	getLayout(Session session, TableHandle tableHandle, Constraint constraint, Optional<Set<ColumnHandle>> desiredColumns) Deprecated.
Optional<NewTableLayout>	getNewTableLayout(Session session, String catalogName, ConnectorTableMetadata tableMetadata)
ProcedureRegistry	getProcedureRegistry()
SchemaPropertyManager	getSchemaPropertyManager()
SessionPropertyManager	getSessionPropertyManager()
TableStatisticsMetadata	getStatisticsCollectionMetadata(Session session, String catalogName, ConnectorTableMetadata tableMetadata) Describe statistics that must be collected during a statistics collection
TableStatisticsMetadata	getStatisticsCollectionMetadataForWrite(Session session, String catalogName, ConnectorTableMetadata tableMetadata) Describes statistics that must be collected during a write.
Optional<SystemTable>	getSystemTable(Session session, QualifiedObjectName tableName)
Optional<TableHandle>	getTableHandle(Session session, QualifiedObjectName tableName) Returns a table handle for the specified table name.
Optional<TableHandle>	getTableHandleForStatisticsCollection(Session session, QualifiedObjectName tableName, Map<String,Object> analyzeProperties)
TableMetadata	getTableMetadata(Session session, TableHandle tableHandle) Return the metadata for the specified table handle.
TableProperties	getTableProperties(Session session, TableHandle handle)
TablePropertyManager	getTablePropertyManager()
TableStatistics	getTableStatistics(Session session, TableHandle tableHandle, Constraint constraint) Return statistics for specified table for given filtering contraint.
Type	getType(TypeSignature signature)
TypeManager	getTypeManager()
ColumnHandle	getUpdateRowIdColumnHandle(Session session, TableHandle tableHandle) Get the row ID column handle used with UpdatablePageSource.
Optional<ViewDefinition>	getView(Session session, QualifiedObjectName viewName) Returns the view definition for the specified view name.
Map<QualifiedObjectName,ViewDefinition>	getViews(Session session, QualifiedTablePrefix prefix) Get the view definitions that match the specified table prefix (never null).
void	grantRoles(Session session, Set<String> roles, Set<PrestoPrincipal> grantees, boolean withAdminOption, Optional<PrestoPrincipal> grantor, String catalog) Grants the specified roles to the specified grantees in the specified catalog
void	grantTablePrivileges(Session session, QualifiedObjectName tableName, Set<Privilege> privileges, PrestoPrincipal grantee, boolean grantOption) Grants the specified privilege to the specified user on the specified table
boolean	isAggregationFunction(QualifiedName name)
Set<RoleGrant>	listApplicableRoles(Session session, PrestoPrincipal principal, String catalog) List applicable roles, including the transitive grants, for the specified principal
Set<String>	listEnabledRoles(Session session, String catalog) List applicable roles, including the transitive grants, in given session
List<SqlFunction>	listFunctions()
Set<RoleGrant>	listRoleGrants(Session session, String catalog, PrestoPrincipal principal) List roles grants in the specified catalog for a given principal, not recursively.
Set<String>	listRoles(Session session, String catalog) List available roles in specified catalog.
List<String>	listSchemaNames(Session session, String catalogName)
Map<QualifiedObjectName,List<ColumnMetadata>>	listTableColumns(Session session, QualifiedTablePrefix prefix) Gets the metadata for all columns that match the specified table prefix.
List<GrantInfo>	listTablePrivileges(Session session, QualifiedTablePrefix prefix) Gets the privileges for the specified table available to the given grantee considering the selected session role
List<QualifiedObjectName>	listTables(Session session, QualifiedTablePrefix prefix) Get the names that match the specified table prefix (never null).
List<QualifiedObjectName>	listViews(Session session, QualifiedTablePrefix prefix) Get the names that match the specified table prefix (never null).
TableHandle	makeCompatiblePartitioning(Session session, TableHandle table, PartitioningHandle partitioningHandle) Return a table handle whose partitioning is converted to the provided partitioning handle, but otherwise identical to the provided table handle.
OptionalLong	metadataDelete(Session session, TableHandle tableHandle) Delete the provide table layout
void	renameColumn(Session session, TableHandle tableHandle, ColumnHandle source, String target) Rename the specified column.
void	renameSchema(Session session, CatalogSchemaName source, String target) Renames the specified schema.
void	renameTable(Session session, TableHandle tableHandle, QualifiedObjectName newTableName) Rename the specified table.
Optional<ResolvedIndex>	resolveIndex(Session session, TableHandle 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.
void	revokeRoles(Session session, Set<String> roles, Set<PrestoPrincipal> grantees, boolean adminOptionFor, Optional<PrestoPrincipal> grantor, String catalog) Revokes the specified roles from the specified grantees in the specified catalog
void	revokeTablePrivileges(Session session, QualifiedObjectName tableName, Set<Privilege> privileges, PrestoPrincipal grantee, boolean grantOption) Revokes the specified privilege on the specified table from the specified user
boolean	schemaExists(Session session, CatalogSchemaName schema)
void	setTableComment(Session session, TableHandle tableHandle, Optional<String> comment) Comments to the specified table.
boolean	supportsMetadataDelete(Session session, TableHandle tableHandle)
boolean	usesLegacyTableLayouts(Session session, TableHandle table) Deprecated.
void	verifyComparableOrderableContract()

Method Detail

verifyComparableOrderableContract

void verifyComparableOrderableContract()

getType

Type getType(TypeSignature signature)

isAggregationFunction

boolean isAggregationFunction(QualifiedName name)

listFunctions

List<SqlFunction> listFunctions()

addFunctions

void addFunctions(List<? extends SqlFunction> functions)

schemaExists

boolean schemaExists(Session session,
                     CatalogSchemaName schema)

catalogExists

boolean catalogExists(Session session,
                      String catalogName)

listSchemaNames

List<String> listSchemaNames(Session session,
                             String catalogName)

getTableHandle

Optional<TableHandle> getTableHandle(Session session,
                                     QualifiedObjectName tableName)

Returns a table handle for the specified table name.

getSystemTable

Optional<SystemTable> getSystemTable(Session session,
                                     QualifiedObjectName tableName)

getTableHandleForStatisticsCollection

Optional<TableHandle> getTableHandleForStatisticsCollection(Session session,
                                                            QualifiedObjectName tableName,
                                                            Map<String,Object> analyzeProperties)

getLayout

@Deprecated
Optional<TableLayoutResult> getLayout(Session session,
                                                  TableHandle tableHandle,
                                                  Constraint constraint,
                                                  Optional<Set<ColumnHandle>> desiredColumns)

Deprecated.

getTableProperties

TableProperties getTableProperties(Session session,
                                   TableHandle handle)

makeCompatiblePartitioning

TableHandle makeCompatiblePartitioning(Session session,
                                       TableHandle table,
                                       PartitioningHandle partitioningHandle)

Return a table handle whose partitioning is converted to the provided partitioning handle, but otherwise identical to the provided table handle. The provided table handle must be one that the connector can transparently convert to from the original partitioning handle associated with the provided table handle, as promised by getCommonPartitioning(io.prestosql.Session, io.prestosql.sql.planner.PartitioningHandle, io.prestosql.sql.planner.PartitioningHandle).

getCommonPartitioning

Optional<PartitioningHandle> getCommonPartitioning(Session session,
                                                   PartitioningHandle left,
                                                   PartitioningHandle right)

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

getInfo

Optional<Object> getInfo(Session session,
                         TableHandle handle)

getTableMetadata

TableMetadata getTableMetadata(Session session,
                               TableHandle tableHandle)

Return the metadata for the specified table handle.

Throws:

RuntimeException - if table handle is no longer valid

getTableStatistics

TableStatistics getTableStatistics(Session session,
                                   TableHandle tableHandle,
                                   Constraint constraint)

Return statistics for specified table for given filtering contraint.

listTables

List<QualifiedObjectName> listTables(Session session,
                                     QualifiedTablePrefix prefix)

Get the names that match the specified table prefix (never null).

getColumnHandles

Map<String,ColumnHandle> getColumnHandles(Session session,
                                          TableHandle 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(Session session,
                                 TableHandle tableHandle,
                                 ColumnHandle columnHandle)

Gets the metadata for the specified table column.

Throws:

RuntimeException - if table or column handles are no longer valid

listTableColumns

Map<QualifiedObjectName,List<ColumnMetadata>> listTableColumns(Session session,
                                                               QualifiedTablePrefix prefix)

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

createSchema

void createSchema(Session session,
                  CatalogSchemaName schema,
                  Map<String,Object> properties)

Creates a schema.

dropSchema

void dropSchema(Session session,
                CatalogSchemaName schema)

Drops the specified schema.

renameSchema

void renameSchema(Session session,
                  CatalogSchemaName source,
                  String target)

Renames the specified schema.

createTable

void createTable(Session session,
                 String catalogName,
                 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

renameTable

void renameTable(Session session,
                 TableHandle tableHandle,
                 QualifiedObjectName newTableName)

Rename the specified table.

setTableComment

void setTableComment(Session session,
                     TableHandle tableHandle,
                     Optional<String> comment)

Comments to the specified table.

renameColumn

void renameColumn(Session session,
                  TableHandle tableHandle,
                  ColumnHandle source,
                  String target)

Rename the specified column.

addColumn

void addColumn(Session session,
               TableHandle tableHandle,
               ColumnMetadata column)

Add the specified column to the table.

dropColumn

void dropColumn(Session session,
                TableHandle tableHandle,
                ColumnHandle column)

Drop the specified column.

dropTable

void dropTable(Session session,
               TableHandle tableHandle)

Drops the specified table

Throws:

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

getNewTableLayout

Optional<NewTableLayout> getNewTableLayout(Session session,
                                           String catalogName,
                                           ConnectorTableMetadata tableMetadata)

beginCreateTable

OutputTableHandle beginCreateTable(Session session,
                                   String catalogName,
                                   ConnectorTableMetadata tableMetadata,
                                   Optional<NewTableLayout> layout)

Begin the atomic creation of a table with data.

finishCreateTable

Optional<ConnectorOutputMetadata> finishCreateTable(Session session,
                                                    OutputTableHandle tableHandle,
                                                    Collection<io.airlift.slice.Slice> fragments,
                                                    Collection<ComputedStatistics> computedStatistics)

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

getInsertLayout

Optional<NewTableLayout> getInsertLayout(Session session,
                                         TableHandle target)

getStatisticsCollectionMetadataForWrite

TableStatisticsMetadata getStatisticsCollectionMetadataForWrite(Session session,
                                                                String catalogName,
                                                                ConnectorTableMetadata tableMetadata)

Describes statistics that must be collected during a write.

getStatisticsCollectionMetadata

TableStatisticsMetadata getStatisticsCollectionMetadata(Session session,
                                                        String catalogName,
                                                        ConnectorTableMetadata tableMetadata)

Describe statistics that must be collected during a statistics collection

beginStatisticsCollection

AnalyzeTableHandle beginStatisticsCollection(Session session,
                                             TableHandle tableHandle)

Begin statistics collection

finishStatisticsCollection

void finishStatisticsCollection(Session session,
                                AnalyzeTableHandle tableHandle,
                                Collection<ComputedStatistics> computedStatistics)

Finish statistics collection

beginQuery

void beginQuery(Session session,
                Set<CatalogName> connectors)

Start a SELECT/UPDATE/INSERT/DELETE query

cleanupQuery

void cleanupQuery(Session session)

Cleanup after a query. This is the very last notification after the query finishes, regardless if it succeeds or fails. An exception thrown in this method will not affect the result of the query.

beginInsert

InsertTableHandle beginInsert(Session session,
                              TableHandle tableHandle)

Begin insert query

finishInsert

Optional<ConnectorOutputMetadata> finishInsert(Session session,
                                               InsertTableHandle tableHandle,
                                               Collection<io.airlift.slice.Slice> fragments,
                                               Collection<ComputedStatistics> computedStatistics)

Finish insert query

getUpdateRowIdColumnHandle

ColumnHandle getUpdateRowIdColumnHandle(Session session,
                                        TableHandle tableHandle)

Get the row ID column handle used with UpdatablePageSource.

supportsMetadataDelete

boolean supportsMetadataDelete(Session session,
                               TableHandle tableHandle)

Returns:

whether delete without table scan is supported

metadataDelete

OptionalLong metadataDelete(Session session,
                            TableHandle tableHandle)

Delete the provide table layout

Returns:

number of rows deleted, or empty for unknown

beginDelete

TableHandle beginDelete(Session session,
                        TableHandle tableHandle)

Begin delete query

finishDelete

void finishDelete(Session session,
                  TableHandle tableHandle,
                  Collection<io.airlift.slice.Slice> fragments)

Finish delete query

getCatalogHandle

Optional<CatalogName> getCatalogHandle(Session session,
                                       String catalogName)

Returns a connector id for the specified catalog name.

getCatalogNames

Map<String,CatalogName> getCatalogNames(Session session)

Gets all the loaded catalogs

Returns:

Map of catalog name to connector id

listViews

List<QualifiedObjectName> listViews(Session session,
                                    QualifiedTablePrefix prefix)

Get the names that match the specified table prefix (never null).

getViews

Map<QualifiedObjectName,ViewDefinition> getViews(Session session,
                                                 QualifiedTablePrefix prefix)

Get the view definitions that match the specified table prefix (never null).

getView

Optional<ViewDefinition> getView(Session session,
                                 QualifiedObjectName viewName)

Returns the view definition for the specified view name.

createView

void createView(Session session,
                QualifiedObjectName viewName,
                String viewData,
                boolean replace)

Creates the specified view with the specified view definition.

dropView

void dropView(Session session,
              QualifiedObjectName viewName)

Drops the specified view.

resolveIndex

Optional<ResolvedIndex> resolveIndex(Session session,
                                     TableHandle 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

void createRole(Session session,
                String role,
                Optional<PrestoPrincipal> grantor,
                String catalog)

Creates the specified role in the specified catalog.

Parameters:

grantor - represents the principal specified by WITH ADMIN statement

dropRole

void dropRole(Session session,
              String role,
              String catalog)

Drops the specified role in the specified catalog.

listRoles

Set<String> listRoles(Session session,
                      String catalog)

List available roles in specified catalog.

listRoleGrants

Set<RoleGrant> listRoleGrants(Session session,
                              String catalog,
                              PrestoPrincipal principal)

List roles grants in the specified catalog for a given principal, not recursively.

grantRoles

void grantRoles(Session session,
                Set<String> roles,
                Set<PrestoPrincipal> grantees,
                boolean withAdminOption,
                Optional<PrestoPrincipal> grantor,
                String catalog)

Grants the specified roles to the specified grantees in the specified catalog

Parameters:

grantor - represents the principal specified by GRANTED BY statement

revokeRoles

void revokeRoles(Session session,
                 Set<String> roles,
                 Set<PrestoPrincipal> grantees,
                 boolean adminOptionFor,
                 Optional<PrestoPrincipal> grantor,
                 String catalog)

Revokes the specified roles from the specified grantees in the specified catalog

Parameters:

grantor - represents the principal specified by GRANTED BY statement

listApplicableRoles

Set<RoleGrant> listApplicableRoles(Session session,
                                   PrestoPrincipal principal,
                                   String catalog)

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

listEnabledRoles

Set<String> listEnabledRoles(Session session,
                             String catalog)

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

grantTablePrivileges

void grantTablePrivileges(Session session,
                          QualifiedObjectName tableName,
                          Set<Privilege> privileges,
                          PrestoPrincipal grantee,
                          boolean grantOption)

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

revokeTablePrivileges

void revokeTablePrivileges(Session session,
                           QualifiedObjectName tableName,
                           Set<Privilege> privileges,
                           PrestoPrincipal grantee,
                           boolean grantOption)

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

listTablePrivileges

List<GrantInfo> listTablePrivileges(Session session,
                                    QualifiedTablePrefix prefix)

Gets the privileges for the specified table available to the given grantee considering the selected session role

getFunctionRegistry

FunctionRegistry getFunctionRegistry()

getProcedureRegistry

ProcedureRegistry getProcedureRegistry()

getTypeManager

TypeManager getTypeManager()

getBlockEncodingSerde

BlockEncodingSerde getBlockEncodingSerde()

getSessionPropertyManager

SessionPropertyManager getSessionPropertyManager()

getSchemaPropertyManager

SchemaPropertyManager getSchemaPropertyManager()

getTablePropertyManager

TablePropertyManager getTablePropertyManager()

getColumnPropertyManager

ColumnPropertyManager getColumnPropertyManager()

getAnalyzePropertyManager

AnalyzePropertyManager getAnalyzePropertyManager()

getConnectorCapabilities

Set<ConnectorCapabilities> getConnectorCapabilities(Session session,
                                                    CatalogName catalogName)

usesLegacyTableLayouts

@Deprecated
boolean usesLegacyTableLayouts(Session session,
                                           TableHandle table)

Deprecated.

applyLimit

Optional<LimitApplicationResult<TableHandle>> applyLimit(Session session,
                                                         TableHandle table,
                                                         long limit)

applyFilter

Optional<ConstraintApplicationResult<TableHandle>> applyFilter(Session session,
                                                               TableHandle table,
                                                               Constraint constraint)

applySample

Optional<TableHandle> applySample(Session session,
                                  TableHandle table,
                                  SampleType sampleType,
                                  double sampleRatio)