Package io.trino.metadata

Interface Metadata

All Known Implementing Classes:

MetadataManager, TracingMetadata

public interface Metadata

Method Summary

Modifier and Type	Method	Description
void	addColumn(Session session, TableHandle tableHandle, CatalogSchemaTableName table, ColumnMetadata column)	Add the specified column to the table.
void	addField(Session session, TableHandle tableHandle, List<String> parentPath, String fieldName, Type type, boolean ignoreExisting)	Add the specified field to the column.
Optional<AggregationApplicationResult<TableHandle>>	applyAggregation(Session session, TableHandle table, List<AggregateFunction> aggregations, Map<String,ColumnHandle> assignments, List<List<ColumnHandle>> groupingSets)
Optional<TableHandle>	applyDelete(Session session, TableHandle tableHandle)	Push delete into connector
Optional<ConstraintApplicationResult<TableHandle>>	applyFilter(Session session, TableHandle table, Constraint constraint)
Optional<JoinApplicationResult<TableHandle>>	applyJoin(Session session, JoinType joinType, TableHandle left, TableHandle right, ConnectorExpression joinCondition, Map<String,ColumnHandle> leftAssignments, Map<String,ColumnHandle> rightAssignments, JoinStatistics statistics)
Optional<LimitApplicationResult<TableHandle>>	applyLimit(Session session, TableHandle table, long limit)
Optional<ProjectionApplicationResult<TableHandle>>	applyProjection(Session session, TableHandle table, List<ConnectorExpression> projections, Map<String,ColumnHandle> assignments)
Optional<SampleApplicationResult<TableHandle>>	applySample(Session session, TableHandle table, SampleType sampleType, double sampleRatio)
Optional<TableFunctionApplicationResult<TableHandle>>	applyTableFunction(Session session, TableFunctionHandle handle)
Optional<TableScanRedirectApplicationResult>	applyTableScanRedirect(Session session, TableHandle tableHandle)	Returns the result of redirecting the table scan on a given table to a different table.
Optional<TopNApplicationResult<TableHandle>>	applyTopN(Session session, TableHandle handle, long topNCount, List<SortItem> sortItems, Map<String,ColumnHandle> assignments)
Optional<TableHandle>	applyUpdate(Session session, TableHandle tableHandle, Map<ColumnHandle,Constant> assignments)	Push update into connector
OutputTableHandle	beginCreateTable(Session session, String catalogName, ConnectorTableMetadata tableMetadata, Optional<TableLayout> layout, boolean replace)	Begin the atomic creation of a table with data.
InsertTableHandle	beginInsert(Session session, TableHandle tableHandle, List<ColumnHandle> columns)	Begin insert query
MergeHandle	beginMerge(Session session, TableHandle tableHandle)	Begin merge query
void	beginQuery(Session session)	Initialize before query begins
InsertTableHandle	beginRefreshMaterializedView(Session session, TableHandle tableHandle, List<TableHandle> sourceTableHandles)	Begin refresh materialized view query
AnalyzeTableHandle	beginStatisticsCollection(Session session, TableHandle tableHandle)	Begin statistics collection
BeginTableExecuteResult<TableExecuteHandle,TableHandle>	beginTableExecute(Session session, TableExecuteHandle handle, TableHandle updatedSourceTableHandle)
boolean	catalogExists(Session session, String catalogName)
void	cleanupQuery(Session session)	Cleanup after a query.
void	createLanguageFunction(Session session, QualifiedObjectName name, LanguageFunction function, boolean replace)
void	createMaterializedView(Session session, QualifiedObjectName viewName, MaterializedViewDefinition definition, Map<String,Object> properties, boolean replace, boolean ignoreExisting)	Creates the specified materialized view with the specified view definition.
void	createRole(Session session, String role, Optional<TrinoPrincipal> grantor, Optional<String> catalog)	Creates the specified role in the specified catalog.
void	createSchema(Session session, CatalogSchemaName schema, Map<String,Object> properties, TrinoPrincipal principal)	Creates a schema.
void	createTable(Session session, String catalogName, ConnectorTableMetadata tableMetadata, SaveMode saveMode)	Creates a table using the specified table metadata.
void	createView(Session session, QualifiedObjectName viewName, ViewDefinition definition, boolean replace)	Creates the specified view with the specified view definition.
ResolvedFunction	decodeFunction(QualifiedName name)
boolean	delegateMaterializedViewRefreshToConnector(Session session, QualifiedObjectName viewName)	Returns true if materialized view refresh should be delegated to connector
default void	denyEntityPrivileges(Session session, EntityKindAndName entity, Set<EntityPrivilege> privileges, TrinoPrincipal grantee)	Deny the specified privileges to the specified principal on the specified entity.
void	denySchemaPrivileges(Session session, CatalogSchemaName schemaName, Set<Privilege> privileges, TrinoPrincipal grantee)	Deny the specified privilege to the specified principal on the specified schema.
void	denyTablePrivileges(Session session, QualifiedObjectName tableName, Set<Privilege> privileges, TrinoPrincipal grantee)	Deny the specified privilege to the specified principal on the specified table
void	dropColumn(Session session, TableHandle tableHandle, CatalogSchemaTableName table, ColumnHandle column)	Drop the specified column.
void	dropField(Session session, TableHandle tableHandle, ColumnHandle column, List<String> fieldPath)	Drop the specified field from the column.
void	dropLanguageFunction(Session session, QualifiedObjectName name, String signatureToken)
void	dropMaterializedView(Session session, QualifiedObjectName viewName)	Drops the specified materialized view.
void	dropNotNullConstraint(Session session, TableHandle tableHandle, ColumnHandle column)	Drop a not null constraint on the specified column.
void	dropRole(Session session, String role, Optional<String> catalog)	Drops the specified role in the specified catalog.
void	dropSchema(Session session, CatalogSchemaName schema, boolean cascade)	Drops the specified schema.
void	dropTable(Session session, TableHandle tableHandle, CatalogSchemaTableName tableName)	Drops the specified table
void	dropView(Session session, QualifiedObjectName viewName)	Drops the specified view.
OptionalLong	executeDelete(Session session, TableHandle tableHandle)	Execute delete in connector
void	executeTableExecute(Session session, TableExecuteHandle handle)
OptionalLong	executeUpdate(Session session, TableHandle tableHandle)	Execute update in connector
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.
Optional<ConnectorOutputMetadata>	finishInsert(Session session, InsertTableHandle tableHandle, List<TableHandle> sourceTableHandles, Collection<io.airlift.slice.Slice> fragments, Collection<ComputedStatistics> computedStatistics)	Finish insert query
void	finishMerge(Session session, MergeHandle tableHandle, Collection<io.airlift.slice.Slice> fragments, Collection<ComputedStatistics> computedStatistics)	Finish merge query
Optional<ConnectorOutputMetadata>	finishRefreshMaterializedView(Session session, TableHandle tableHandle, InsertTableHandle insertTableHandle, Collection<io.airlift.slice.Slice> fragments, Collection<ComputedStatistics> computedStatistics, List<TableHandle> sourceTableHandles, List<String> sourceTableFunctions)	Finish refresh materialized view query
void	finishStatisticsCollection(Session session, AnalyzeTableHandle tableHandle, Collection<ComputedStatistics> computedStatistics)	Finish statistics collection
void	finishTableExecute(Session session, TableExecuteHandle handle, Collection<io.airlift.slice.Slice> fragments, List<Object> tableExecuteState)
AggregationFunctionMetadata	getAggregationFunctionMetadata(Session session, ResolvedFunction resolvedFunction)
default Set<EntityPrivilege>	getAllEntityKindPrivileges(String entityKind)	Gets all the EntityPrivileges associated with an entityKind.
Optional<CatalogHandle>	getCatalogHandle(Session session, String catalogName)	Returns a catalog handle for the specified catalog name.
ResolvedFunction	getCoercion(CatalogSchemaFunctionName name, Type fromType, Type toType)
ResolvedFunction	getCoercion(OperatorType operatorType, Type fromType, Type toType)
default ResolvedFunction	getCoercion(Type fromType, Type toType)
Map<String,ColumnHandle>	getColumnHandles(Session session, TableHandle tableHandle)	Gets all of the columns on the specified table, or an empty map if the columns cannot be enumerated.
ColumnMetadata	getColumnMetadata(Session session, TableHandle tableHandle, ColumnHandle columnHandle)	Gets the metadata for the specified table column.
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, CatalogHandle catalogHandle)
FunctionDependencyDeclaration	getFunctionDependencies(Session session, CatalogHandle catalogHandle, FunctionId functionId, BoundSignature boundSignature)
Collection<CatalogFunctionMetadata>	getFunctions(Session session, CatalogSchemaFunctionName catalogSchemaFunctionName)
Optional<Object>	getInfo(Session session, TableHandle handle)
Optional<TableLayout>	getInsertLayout(Session session, TableHandle target)
WriterScalingOptions	getInsertWriterScalingOptions(Session session, TableHandle tableHandle)	Returns writer scaling options for the specified table.
Optional<TableLayout>	getLayoutForTableExecute(Session session, TableExecuteHandle tableExecuteHandle)
Optional<MaterializedViewDefinition>	getMaterializedView(Session session, QualifiedObjectName viewName)	Returns the materialized view definition for the specified view name.
MaterializedViewFreshness	getMaterializedViewFreshness(Session session, QualifiedObjectName name)	Method to get difference between the states of table at two different points in time/or as of given token-ids.
Map<String,Object>	getMaterializedViewProperties(Session session, QualifiedObjectName objectName, MaterializedViewDefinition materializedViewDefinition)
Map<QualifiedObjectName,ViewInfo>	getMaterializedViews(Session session, QualifiedTablePrefix prefix)	Get the materialized view definitions that match the specified table prefix (never null).
OptionalInt	getMaxWriterTasks(Session session, String catalogName)	Returns maximum number of tasks that can be created while writing data to specific connector.
ColumnHandle	getMergeRowIdColumnHandle(Session session, TableHandle tableHandle)	Get the column handle that will generate row IDs for the merge operation.
Optional<TableLayout>	getNewTableLayout(Session session, String catalogName, ConnectorTableMetadata tableMetadata)
WriterScalingOptions	getNewTableWriterScalingOptions(Session session, QualifiedObjectName tableName, Map<String,Object> tableProperties)	Returns writer scaling options for the specified table.
RedirectionAwareTableHandle	getRedirectionAwareTableHandle(Session session, QualifiedObjectName tableName)	Get the target table handle after performing redirection.
RedirectionAwareTableHandle	getRedirectionAwareTableHandle(Session session, QualifiedObjectName tableName, Optional<TableVersion> startVersion, Optional<TableVersion> endVersion)	Get the target table handle after performing redirection with a table version.
Map<SchemaTableName,RelationType>	getRelationTypes(Session session, QualifiedTablePrefix prefix)	Get the relation names that match the specified table prefix (never null).
RowChangeParadigm	getRowChangeParadigm(Session session, TableHandle tableHandle)	Return the row update paradigm supported by the connector on the table or throw an exception if row change is not supported.
Optional<TrinoPrincipal>	getSchemaOwner(Session session, CatalogSchemaName schemaName)	Gets the schema owner for the specified schema.
Map<String,Object>	getSchemaProperties(Session session, CatalogSchemaName schemaName)	Gets the schema properties for the specified schema.
AnalyzeMetadata	getStatisticsCollectionMetadata(Session session, TableHandle tableHandle, Map<String,Object> analyzeProperties)	Describe statistics that must be collected during a statistics collection
TableStatisticsMetadata	getStatisticsCollectionMetadataForWrite(Session session, CatalogHandle catalogHandle, ConnectorTableMetadata tableMetadata)	Describes statistics that must be collected during a write.
Optional<Type>	getSupportedType(Session session, CatalogHandle catalogHandle, Map<String,Object> tableProperties, Type type)	Return the effective Type that is supported by the connector for the given type, if Optional.empty() is returned, the type will be used as is during table creation which may or may not be supported by the connector.
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>	getTableHandle(Session session, QualifiedObjectName tableName, Optional<TableVersion> startVersion, Optional<TableVersion> endVersion)	Returns a table handle for the specified table name with a specified version
Optional<TableExecuteHandle>	getTableHandleForExecute(Session session, TableHandle tableHandle, String procedureName, Map<String,Object> executeProperties)
TableMetadata	getTableMetadata(Session session, TableHandle tableHandle)	Return the metadata for the specified table handle.
CatalogSchemaTableName	getTableName(Session session, TableHandle tableHandle)
TableProperties	getTableProperties(Session session, TableHandle handle)
TableSchema	getTableSchema(Session session, TableHandle tableHandle)	Return table schema definition for the specified table handle.
TableStatistics	getTableStatistics(Session session, TableHandle tableHandle)	Return statistics for specified table.
Optional<PartitioningHandle>	getUpdateLayout(Session session, TableHandle tableHandle)	Get the physical layout for updated or deleted rows of a MERGE operation.
Optional<ViewDefinition>	getView(Session session, QualifiedObjectName viewName)	Returns the view definition for the specified view name.
Map<QualifiedObjectName,ViewInfo>	getViews(Session session, QualifiedTablePrefix prefix)	Get the view definitions that match the specified table prefix (never null).
default void	grantEntityPrivileges(Session session, EntityKindAndName entity, Set<EntityPrivilege> privileges, TrinoPrincipal grantee, boolean grantOption)	Grants the specified privileges to the specified user on the specified grantee.
void	grantRoles(Session session, Set<String> roles, Set<TrinoPrincipal> grantees, boolean adminOption, Optional<TrinoPrincipal> grantor, Optional<String> catalog)	Grants the specified roles to the specified grantees in the specified catalog
void	grantSchemaPrivileges(Session session, CatalogSchemaName schemaName, Set<Privilege> privileges, TrinoPrincipal grantee, boolean grantOption)	Grants the specified privilege to the specified user on the specified schema.
void	grantTablePrivileges(Session session, QualifiedObjectName tableName, Set<Privilege> privileges, TrinoPrincipal grantee, boolean grantOption)	Grants the specified privilege to the specified user on the specified table
boolean	isCatalogManagedSecurity(Session session, String catalog)	Does the specified catalog manage security directly, or does it use system security management?
default boolean	isMaterializedView(Session session, QualifiedObjectName viewName)	Is the specified table a materialized view.
default boolean	isView(Session session, QualifiedObjectName viewName)	Is the specified table a view.
boolean	languageFunctionExists(Session session, QualifiedObjectName name, String signatureToken)
Set<RoleGrant>	listApplicableRoles(Session session, TrinoPrincipal principal, Optional<String> catalog)	List applicable roles, including the transitive grants, for the specified principal
List<CatalogInfo>	listCatalogs(Session session)	Gets all the loaded catalogs
Set<String>	listEnabledRoles(Session session, String catalog)	List applicable roles, including the transitive grants, in given catalog
Set<String>	listEnabledRoles(Identity identity)	List applicable system roles, including the transitive grants, for the given identity.
Collection<FunctionMetadata>	listFunctions(Session session, CatalogSchemaName schema)
Collection<FunctionMetadata>	listGlobalFunctions(Session session)
List<QualifiedObjectName>	listMaterializedViews(Session session, QualifiedTablePrefix prefix)	Get the names that match the specified table prefix (never null).
List<RelationCommentMetadata>	listRelationComments(Session session, String catalogName, Optional<String> schemaName, UnaryOperator<Set<SchemaTableName>> relationFilter)	Gets the comments metadata for all relations (tables, views, materialized views) that match the specified prefix.
Set<RoleGrant>	listRoleGrants(Session session, Optional<String> catalog, TrinoPrincipal principal)	List roles grants in the specified catalog for a given principal, not recursively.
Set<String>	listRoles(Session session, Optional<String> catalog)	List available roles in specified catalog.
List<String>	listSchemaNames(Session session, String catalogName)
List<TableColumnsMetadata>	listTableColumns(Session session, QualifiedTablePrefix prefix, UnaryOperator<Set<SchemaTableName>> relationFilter)	Gets the columns metadata for all tables that match the specified 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 relation 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.
com.google.common.util.concurrent.ListenableFuture<Void>	refreshMaterializedView(Session session, QualifiedObjectName viewName)	Refresh materialized view
void	renameColumn(Session session, TableHandle tableHandle, CatalogSchemaTableName table, ColumnHandle source, String target)	Rename the specified column.
void	renameField(Session session, TableHandle tableHandle, List<String> fieldPath, String target)	Rename the specified field.
void	renameMaterializedView(Session session, QualifiedObjectName existingViewName, QualifiedObjectName newViewName)	Rename the specified materialized view.
void	renameSchema(Session session, CatalogSchemaName source, String target)	Renames the specified schema.
void	renameTable(Session session, TableHandle tableHandle, CatalogSchemaTableName currentTableName, QualifiedObjectName newTableName)	Rename the specified table.
void	renameView(Session session, QualifiedObjectName existingViewName, QualifiedObjectName newViewName)	Rename the specified view.
ResolvedFunction	resolveBuiltinFunction(String name, List<TypeSignatureProvider> parameterTypes)
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.
ResolvedFunction	resolveOperator(OperatorType operatorType, List<? extends Type> argumentTypes)
default void	revokeEntityPrivileges(Session session, EntityKindAndName entity, Set<EntityPrivilege> privileges, TrinoPrincipal grantee, boolean grantOption)	Revokes the specified privilege on the specified entity from the specified grantee.
void	revokeRoles(Session session, Set<String> roles, Set<TrinoPrincipal> grantees, boolean adminOption, Optional<TrinoPrincipal> grantor, Optional<String> catalog)	Revokes the specified roles from the specified grantees in the specified catalog
void	revokeSchemaPrivileges(Session session, CatalogSchemaName schemaName, Set<Privilege> privileges, TrinoPrincipal grantee, boolean grantOption)	Revokes the specified privilege on the specified schema from the specified user.
void	revokeTablePrivileges(Session session, QualifiedObjectName tableName, Set<Privilege> privileges, TrinoPrincipal grantee, boolean grantOption)	Revokes the specified privilege on the specified table from the specified user.
boolean	roleExists(Session session, String role, Optional<String> catalog)	Does the specified role exist.
boolean	schemaExists(Session session, CatalogSchemaName schema)
void	setColumnComment(Session session, TableHandle tableHandle, ColumnHandle column, Optional<String> comment)	Comments to the specified column.
void	setColumnType(Session session, TableHandle tableHandle, ColumnHandle column, Type type)	Set the specified type to the column.
void	setFieldType(Session session, TableHandle tableHandle, List<String> fieldPath, Type type)	Set the specified type to the field.
void	setMaterializedViewColumnComment(Session session, QualifiedObjectName viewName, String columnName, Optional<String> comment)	Comments to the specified materialized view column.
void	setMaterializedViewProperties(Session session, QualifiedObjectName viewName, Map<String,Optional<Object>> properties)	Sets the properties of the specified materialized view.
void	setSchemaAuthorization(Session session, CatalogSchemaName source, TrinoPrincipal principal)	Set the specified schema's user/role.
void	setTableAuthorization(Session session, CatalogSchemaTableName table, TrinoPrincipal principal)	Set the authorization (owner) of specified table's user/role
void	setTableComment(Session session, TableHandle tableHandle, Optional<String> comment)	Comments to the specified table.
void	setTableProperties(Session session, TableHandle tableHandle, Map<String,Optional<Object>> properties)	Set properties to the specified table.
void	setViewAuthorization(Session session, CatalogSchemaTableName view, TrinoPrincipal principal)	Set the authorization (owner) of specified view's user/role
void	setViewColumnComment(Session session, QualifiedObjectName viewName, String columnName, Optional<String> comment)	Comments to the specified view column.
void	setViewComment(Session session, QualifiedObjectName viewName, Optional<String> comment)	Comments to the specified view.
boolean	supportsMissingColumnsOnInsert(Session session, TableHandle tableHandle)
void	truncateTable(Session session, TableHandle tableHandle)	Truncates the specified table
default void	validateScan(Session session, TableHandle table)

Method Details

getConnectorCapabilities

Set<ConnectorCapabilities> getConnectorCapabilities(Session session,
 CatalogHandle catalogHandle)

catalogExists

boolean catalogExists(Session session,
 String catalogName)

schemaExists

boolean schemaExists(Session session,
 CatalogSchemaName schema)

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)

getTableHandleForExecute

Optional<TableExecuteHandle> getTableHandleForExecute(Session session,
 TableHandle tableHandle,
 String procedureName,
 Map<String,Object> executeProperties)

getLayoutForTableExecute

Optional<TableLayout> getLayoutForTableExecute(Session session,
 TableExecuteHandle tableExecuteHandle)

beginTableExecute

BeginTableExecuteResult<TableExecuteHandle,TableHandle> beginTableExecute(Session session,
 TableExecuteHandle handle,
 TableHandle updatedSourceTableHandle)

finishTableExecute

void finishTableExecute(Session session,
 TableExecuteHandle handle,
 Collection<io.airlift.slice.Slice> fragments,
 List<Object> tableExecuteState)

executeTableExecute

void executeTableExecute(Session session,
 TableExecuteHandle handle)

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.trino.Session, io.trino.sql.planner.PartitioningHandle, io.trino.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)

getTableName

CatalogSchemaTableName getTableName(Session session,
 TableHandle tableHandle)

getTableSchema

TableSchema getTableSchema(Session session,
 TableHandle tableHandle)

Return table schema definition for the specified table handle. Table schema definition is a set of information required by semantic analyzer to analyze the query.

Throws:

RuntimeException - if table handle is no longer valid

See Also:

• getTableMetadata(Session, TableHandle)

getTableMetadata

TableMetadata getTableMetadata(Session session,
 TableHandle tableHandle)

Return the metadata for the specified table handle.

Throws:

RuntimeException - if table handle is no longer valid

See Also:

• a different method which is less expensive.

getTableStatistics

TableStatistics getTableStatistics(Session session,
 TableHandle tableHandle)

Return statistics for specified table.

listTables

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

Get the relation names that match the specified table prefix (never null). This includes all relations (e.g. tables, views, materialized views).

getRelationTypes

Map<SchemaTableName,RelationType> getRelationTypes(Session session,
 QualifiedTablePrefix prefix)

Get the relation names that match the specified table prefix (never null). This includes all relations (e.g. tables, views, materialized views).

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 cannot 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

List<TableColumnsMetadata> listTableColumns(Session session,
 QualifiedTablePrefix prefix,
 UnaryOperator<Set<SchemaTableName>> relationFilter)

Gets the columns metadata for all tables that match the specified prefix. TODO: consider returning a stream for more efficient processing

listRelationComments

List<RelationCommentMetadata> listRelationComments(Session session,
 String catalogName,
 Optional<String> schemaName,
 UnaryOperator<Set<SchemaTableName>> relationFilter)

Gets the comments metadata for all relations (tables, views, materialized views) that match the specified prefix. TODO: consider returning a stream for more efficient processing

createSchema

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

Creates a schema.

Parameters:

principal - TODO

dropSchema

void dropSchema(Session session,
 CatalogSchemaName schema,
 boolean cascade)

Drops the specified schema.

renameSchema

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

Renames the specified schema.

setSchemaAuthorization

void setSchemaAuthorization(Session session,
 CatalogSchemaName source,
 TrinoPrincipal principal)

Set the specified schema's user/role.

createTable

void createTable(Session session,
 String catalogName,
 ConnectorTableMetadata tableMetadata,
 SaveMode saveMode)

Creates a table using the specified table metadata.

Throws:

TrinoException - with ALREADY_EXISTS if the table already exists and saveMode is set to FAIL.

renameTable

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

Rename the specified table.

setTableProperties

void setTableProperties(Session session,
 TableHandle tableHandle,
 Map<String,Optional<Object>> properties)

Set properties to the specified table.

setTableComment

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

Comments to the specified table.

setViewComment

void setViewComment(Session session,
 QualifiedObjectName viewName,
 Optional<String> comment)

Comments to the specified view.

setViewColumnComment

void setViewColumnComment(Session session,
 QualifiedObjectName viewName,
 String columnName,
 Optional<String> comment)

Comments to the specified view column.

setColumnComment

void setColumnComment(Session session,
 TableHandle tableHandle,
 ColumnHandle column,
 Optional<String> comment)

Comments to the specified column.

renameColumn

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

Rename the specified column.

renameField

void renameField(Session session,
 TableHandle tableHandle,
 List<String> fieldPath,
 String target)

Rename the specified field.

addColumn

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

Add the specified column to the table.

addField

void addField(Session session,
 TableHandle tableHandle,
 List<String> parentPath,
 String fieldName,
 Type type,
 boolean ignoreExisting)

Add the specified field to the column.

setColumnType

void setColumnType(Session session,
 TableHandle tableHandle,
 ColumnHandle column,
 Type type)

Set the specified type to the column.

setFieldType

void setFieldType(Session session,
 TableHandle tableHandle,
 List<String> fieldPath,
 Type type)

Set the specified type to the field.

dropNotNullConstraint

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

Drop a not null constraint on the specified column.

setTableAuthorization

void setTableAuthorization(Session session,
 CatalogSchemaTableName table,
 TrinoPrincipal principal)

Set the authorization (owner) of specified table's user/role

dropColumn

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

Drop the specified column.

dropField

void dropField(Session session,
 TableHandle tableHandle,
 ColumnHandle column,
 List<String> fieldPath)

Drop the specified field from the column.

dropTable

void dropTable(Session session,
 TableHandle tableHandle,
 CatalogSchemaTableName tableName)

Drops the specified table

Throws:

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

truncateTable

void truncateTable(Session session,
 TableHandle tableHandle)

Truncates the specified table

getNewTableLayout

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

getSupportedType

Optional<Type> getSupportedType(Session session,
 CatalogHandle catalogHandle,
 Map<String,Object> tableProperties,
 Type type)

Return the effective Type that is supported by the connector for the given type, if Optional.empty() is returned, the type will be used as is during table creation which may or may not be supported by the connector.

beginCreateTable

OutputTableHandle beginCreateTable(Session session,
 String catalogName,
 ConnectorTableMetadata tableMetadata,
 Optional<TableLayout> layout,
 boolean replace)

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<TableLayout> getInsertLayout(Session session,
 TableHandle target)

getStatisticsCollectionMetadataForWrite

TableStatisticsMetadata getStatisticsCollectionMetadataForWrite(Session session,
 CatalogHandle catalogHandle,
 ConnectorTableMetadata tableMetadata)

Describes statistics that must be collected during a write.

getStatisticsCollectionMetadata

AnalyzeMetadata getStatisticsCollectionMetadata(Session session,
 TableHandle tableHandle,
 Map<String,Object> analyzeProperties)

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)

Initialize before query begins

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,
 List<ColumnHandle> columns)

Begin insert query

supportsMissingColumnsOnInsert

boolean supportsMissingColumnsOnInsert(Session session,
 TableHandle tableHandle)

Returns:

whether connector handles missing columns during insert

finishInsert

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

Finish insert query

delegateMaterializedViewRefreshToConnector

boolean delegateMaterializedViewRefreshToConnector(Session session,
 QualifiedObjectName viewName)

Returns true if materialized view refresh should be delegated to connector

refreshMaterializedView

com.google.common.util.concurrent.ListenableFuture<Void> refreshMaterializedView(Session session,
 QualifiedObjectName viewName)

Refresh materialized view

beginRefreshMaterializedView

InsertTableHandle beginRefreshMaterializedView(Session session,
 TableHandle tableHandle,
 List<TableHandle> sourceTableHandles)

Begin refresh materialized view query

finishRefreshMaterializedView

Optional<ConnectorOutputMetadata> finishRefreshMaterializedView(Session session,
 TableHandle tableHandle,
 InsertTableHandle insertTableHandle,
 Collection<io.airlift.slice.Slice> fragments,
 Collection<ComputedStatistics> computedStatistics,
 List<TableHandle> sourceTableHandles,
 List<String> sourceTableFunctions)

Finish refresh materialized view query

applyUpdate

Optional<TableHandle> applyUpdate(Session session,
 TableHandle tableHandle,
 Map<ColumnHandle,Constant> assignments)

Push update into connector

executeUpdate

OptionalLong executeUpdate(Session session,
 TableHandle tableHandle)

Execute update in connector

applyDelete

Optional<TableHandle> applyDelete(Session session,
 TableHandle tableHandle)

Push delete into connector

executeDelete

OptionalLong executeDelete(Session session,
 TableHandle tableHandle)

Execute delete in connector

getRowChangeParadigm

RowChangeParadigm getRowChangeParadigm(Session session,
 TableHandle tableHandle)

Return the row update paradigm supported by the connector on the table or throw an exception if row change is not supported.

getMergeRowIdColumnHandle

ColumnHandle getMergeRowIdColumnHandle(Session session,
 TableHandle tableHandle)

Get the column handle that will generate row IDs for the merge operation. These IDs will be passed to the storeMergedRows() method of the ConnectorMergeSink that created them.

getUpdateLayout

Optional<PartitioningHandle> getUpdateLayout(Session session,
 TableHandle tableHandle)

Get the physical layout for updated or deleted rows of a MERGE operation.

beginMerge

MergeHandle beginMerge(Session session,
 TableHandle tableHandle)

Begin merge query

finishMerge

void finishMerge(Session session,
 MergeHandle tableHandle,
 Collection<io.airlift.slice.Slice> fragments,
 Collection<ComputedStatistics> computedStatistics)

Finish merge query

getCatalogHandle

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

Returns a catalog handle for the specified catalog name.

listCatalogs

List<CatalogInfo> listCatalogs(Session session)

Gets all the loaded catalogs

listViews

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

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

getViews

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

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

isView

default boolean isView(Session session,
 QualifiedObjectName viewName)

Is the specified table a view.

getView

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

Returns the view definition for the specified view name.

getSchemaProperties

Map<String,Object> getSchemaProperties(Session session,
 CatalogSchemaName schemaName)

Gets the schema properties for the specified schema.

getSchemaOwner

Optional<TrinoPrincipal> getSchemaOwner(Session session,
 CatalogSchemaName schemaName)

Gets the schema owner for the specified schema.

createView

void createView(Session session,
 QualifiedObjectName viewName,
 ViewDefinition definition,
 boolean replace)

Creates the specified view with the specified view definition.

renameView

void renameView(Session session,
 QualifiedObjectName existingViewName,
 QualifiedObjectName newViewName)

Rename the specified view.

setViewAuthorization

void setViewAuthorization(Session session,
 CatalogSchemaTableName view,
 TrinoPrincipal principal)

Set the authorization (owner) of specified view's user/role

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.

applyLimit

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

applyFilter

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

applyProjection

Optional<ProjectionApplicationResult<TableHandle>> applyProjection(Session session,
 TableHandle table,
 List<ConnectorExpression> projections,
 Map<String,ColumnHandle> assignments)

applySample

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

applyAggregation

Optional<AggregationApplicationResult<TableHandle>> applyAggregation(Session session,
 TableHandle table,
 List<AggregateFunction> aggregations,
 Map<String,ColumnHandle> assignments,
 List<List<ColumnHandle>> groupingSets)

applyJoin

Optional<JoinApplicationResult<TableHandle>> applyJoin(Session session,
 JoinType joinType,
 TableHandle left,
 TableHandle right,
 ConnectorExpression joinCondition,
 Map<String,ColumnHandle> leftAssignments,
 Map<String,ColumnHandle> rightAssignments,
 JoinStatistics statistics)

applyTopN

Optional<TopNApplicationResult<TableHandle>> applyTopN(Session session,
 TableHandle handle,
 long topNCount,
 List<SortItem> sortItems,
 Map<String,ColumnHandle> assignments)

applyTableFunction

Optional<TableFunctionApplicationResult<TableHandle>> applyTableFunction(Session session,
 TableFunctionHandle handle)

validateScan

default void validateScan(Session session,
 TableHandle table)

isCatalogManagedSecurity

boolean isCatalogManagedSecurity(Session session,
 String catalog)

Does the specified catalog manage security directly, or does it use system security management?

roleExists

boolean roleExists(Session session,
 String role,
 Optional<String> catalog)

Does the specified role exist.

Parameters:

catalog - if present, the role catalog; otherwise the role is a system role

createRole

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

Creates the specified role in the specified catalog.

Parameters:

grantor - represents the principal specified by WITH ADMIN statement

catalog - if present, the role catalog; otherwise the role is a system role

dropRole

void dropRole(Session session,
 String role,
 Optional<String> catalog)

Drops the specified role in the specified catalog.

Parameters:

catalog - if present, the role catalog; otherwise the role is a system role

listRoles

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

List available roles in specified catalog.

Parameters:

catalog - if present, the role catalog; otherwise the role is a system role

listRoleGrants

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

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

Parameters:

catalog - if present, the role catalog; otherwise the role is a system role

grantRoles

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

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

Parameters:

grantor - represents the principal specified by GRANTED BY statement

catalog - if present, the role catalog; otherwise the role is a system role

revokeRoles

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

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

Parameters:

grantor - represents the principal specified by GRANTED BY statement

catalog - if present, the role catalog; otherwise the role is a system role

listApplicableRoles

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

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

Parameters:

catalog - if present, the role catalog; otherwise the role is a system role

listEnabledRoles

Set<String> listEnabledRoles(Identity identity)

List applicable system roles, including the transitive grants, for the given identity.

listEnabledRoles

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

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

Parameters:

catalog - if present, the role catalog; otherwise the role is a system role

grantSchemaPrivileges

void grantSchemaPrivileges(Session session,
 CatalogSchemaName schemaName,
 Set<Privilege> privileges,
 TrinoPrincipal grantee,
 boolean grantOption)

Grants the specified privilege to the specified user on the specified schema.

denySchemaPrivileges

void denySchemaPrivileges(Session session,
 CatalogSchemaName schemaName,
 Set<Privilege> privileges,
 TrinoPrincipal grantee)

Deny the specified privilege to the specified principal on the specified schema.

revokeSchemaPrivileges

void revokeSchemaPrivileges(Session session,
 CatalogSchemaName schemaName,
 Set<Privilege> privileges,
 TrinoPrincipal grantee,
 boolean grantOption)

Revokes the specified privilege on the specified schema from the specified user.

grantTablePrivileges

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

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

denyTablePrivileges

void denyTablePrivileges(Session session,
 QualifiedObjectName tableName,
 Set<Privilege> privileges,
 TrinoPrincipal grantee)

Deny the specified privilege to the specified principal on the specified table

revokeTablePrivileges

void revokeTablePrivileges(Session session,
 QualifiedObjectName tableName,
 Set<Privilege> privileges,
 TrinoPrincipal 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

getAllEntityKindPrivileges

default Set<EntityPrivilege> getAllEntityKindPrivileges(String entityKind)

Gets all the EntityPrivileges associated with an entityKind. Defines ALL PRIVILEGES for the entityKind

grantEntityPrivileges

default void grantEntityPrivileges(Session session,
 EntityKindAndName entity,
 Set<EntityPrivilege> privileges,
 TrinoPrincipal grantee,
 boolean grantOption)

Grants the specified privileges to the specified user on the specified grantee. If the set of privileges is empty, it is interpreted as all privileges for the entityKind.

denyEntityPrivileges

default void denyEntityPrivileges(Session session,
 EntityKindAndName entity,
 Set<EntityPrivilege> privileges,
 TrinoPrincipal grantee)

Deny the specified privileges to the specified principal on the specified entity. If the set of privileges is empty, it is interpreted as all privileges for the entityKind.

revokeEntityPrivileges

default void revokeEntityPrivileges(Session session,
 EntityKindAndName entity,
 Set<EntityPrivilege> privileges,
 TrinoPrincipal grantee,
 boolean grantOption)

Revokes the specified privilege on the specified entity from the specified grantee. If the set of privileges is empty, it is interpreted as all privileges for the entityKind.

listGlobalFunctions

Collection<FunctionMetadata> listGlobalFunctions(Session session)

listFunctions

Collection<FunctionMetadata> listFunctions(Session session,
 CatalogSchemaName schema)

decodeFunction

ResolvedFunction decodeFunction(QualifiedName name)

getFunctions

Collection<CatalogFunctionMetadata> getFunctions(Session session,
 CatalogSchemaFunctionName catalogSchemaFunctionName)

resolveBuiltinFunction

ResolvedFunction resolveBuiltinFunction(String name,
 List<TypeSignatureProvider> parameterTypes)

resolveOperator

ResolvedFunction resolveOperator(OperatorType operatorType,
 List<? extends Type> argumentTypes)
                          throws OperatorNotFoundException

Throws:

OperatorNotFoundException

getCoercion

default ResolvedFunction getCoercion(Type fromType,
 Type toType)

getCoercion

ResolvedFunction getCoercion(OperatorType operatorType,
 Type fromType,
 Type toType)

getCoercion

ResolvedFunction getCoercion(CatalogSchemaFunctionName name,
 Type fromType,
 Type toType)

getAggregationFunctionMetadata

AggregationFunctionMetadata getAggregationFunctionMetadata(Session session,
 ResolvedFunction resolvedFunction)

getFunctionDependencies

FunctionDependencyDeclaration getFunctionDependencies(Session session,
 CatalogHandle catalogHandle,
 FunctionId functionId,
 BoundSignature boundSignature)

languageFunctionExists

boolean languageFunctionExists(Session session,
 QualifiedObjectName name,
 String signatureToken)

createLanguageFunction

void createLanguageFunction(Session session,
 QualifiedObjectName name,
 LanguageFunction function,
 boolean replace)

dropLanguageFunction

void dropLanguageFunction(Session session,
 QualifiedObjectName name,
 String signatureToken)

createMaterializedView

void createMaterializedView(Session session,
 QualifiedObjectName viewName,
 MaterializedViewDefinition definition,
 Map<String,Object> properties,
 boolean replace,
 boolean ignoreExisting)

Creates the specified materialized view with the specified view definition.

dropMaterializedView

void dropMaterializedView(Session session,
 QualifiedObjectName viewName)

Drops the specified materialized view.

listMaterializedViews

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

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

getMaterializedViews

Map<QualifiedObjectName,ViewInfo> getMaterializedViews(Session session,
 QualifiedTablePrefix prefix)

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

isMaterializedView

default boolean isMaterializedView(Session session,
 QualifiedObjectName viewName)

Is the specified table a materialized view.

getMaterializedView

Optional<MaterializedViewDefinition> getMaterializedView(Session session,
 QualifiedObjectName viewName)

Returns the materialized view definition for the specified view name.

getMaterializedViewProperties

Map<String,Object> getMaterializedViewProperties(Session session,
 QualifiedObjectName objectName,
 MaterializedViewDefinition materializedViewDefinition)

getMaterializedViewFreshness

MaterializedViewFreshness getMaterializedViewFreshness(Session session,
 QualifiedObjectName name)

Method to get difference between the states of table at two different points in time/or as of given token-ids. The method is used by the engine to determine if a materialized view is current with respect to the tables it depends on.

renameMaterializedView

void renameMaterializedView(Session session,
 QualifiedObjectName existingViewName,
 QualifiedObjectName newViewName)

Rename the specified materialized view.

setMaterializedViewProperties

void setMaterializedViewProperties(Session session,
 QualifiedObjectName viewName,
 Map<String,Optional<Object>> properties)

Sets the properties of the specified materialized view.

setMaterializedViewColumnComment

void setMaterializedViewColumnComment(Session session,
 QualifiedObjectName viewName,
 String columnName,
 Optional<String> comment)

Comments to the specified materialized view column.

applyTableScanRedirect

Optional<TableScanRedirectApplicationResult> applyTableScanRedirect(Session session,
 TableHandle tableHandle)

Returns the result of redirecting the table scan on a given table to a different table. This method is used by the engine during the plan optimization phase to allow a connector to offload table scans to any other connector. This method is called after security checks against the original table.

getRedirectionAwareTableHandle

RedirectionAwareTableHandle getRedirectionAwareTableHandle(Session session,
 QualifiedObjectName tableName)

Get the target table handle after performing redirection.

getRedirectionAwareTableHandle

RedirectionAwareTableHandle getRedirectionAwareTableHandle(Session session,
 QualifiedObjectName tableName,
 Optional<TableVersion> startVersion,
 Optional<TableVersion> endVersion)

Get the target table handle after performing redirection with a table version.

getTableHandle

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

Returns a table handle for the specified table name with a specified version

getMaxWriterTasks

OptionalInt getMaxWriterTasks(Session session,
 String catalogName)

Returns maximum number of tasks that can be created while writing data to specific connector. Note: It is ignored when retry policy is set to TASK

getNewTableWriterScalingOptions

WriterScalingOptions getNewTableWriterScalingOptions(Session session,
 QualifiedObjectName tableName,
 Map<String,Object> tableProperties)

Returns writer scaling options for the specified table. This method is called when table handle is not available during CTAS.

getInsertWriterScalingOptions

WriterScalingOptions getInsertWriterScalingOptions(Session session,
 TableHandle tableHandle)

Returns writer scaling options for the specified table.