org.apache.flink.table.catalog

Class CatalogManager

java.lang.Object

org.apache.flink.table.catalog.CatalogManager

@Internal
public final class CatalogManager
extends Object

A manager for dealing with catalog objects such as tables, views, functions, and types. It encapsulates all available catalogs and stores temporary objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogManager.Builder Builder for a fluent definition of a CatalogManager.

Method Summary

Modifier and Type	Method and Description
void	alterTable(CatalogBaseTable table, List<TableChange> changes, ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Alters a table in a given fully qualified path with table changes.
void	alterTable(CatalogBaseTable table, ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Alters a table in a given fully qualified path.
void	createTable(CatalogBaseTable table, ObjectIdentifier objectIdentifier, boolean ignoreIfExists) Creates a table in a given fully qualified path.
void	createTemporaryTable(CatalogBaseTable table, ObjectIdentifier objectIdentifier, boolean ignoreIfExists) Creates a temporary table in a given fully qualified path.
void	dropTable(ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Drops a table in a given fully qualified path.
void	dropTemporaryTable(ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Drop a temporary table in a given fully qualified path.
void	dropTemporaryView(ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Drop a temporary view in a given fully qualified path.
void	dropView(ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Drops a view in a given fully qualified path.
String	getBuiltInCatalogName() Gets the built-in catalog name.
String	getBuiltInDatabaseName() Gets the built-in database name in the built-in catalog.
Optional<Catalog>	getCatalog(String catalogName) Gets a catalog by name.
String	getCurrentCatalog() Gets the current catalog that will be used when resolving table path.
String	getCurrentDatabase() Gets the current database name that will be used when resolving table path.
DataTypeFactory	getDataTypeFactory() Returns a factory for creating fully resolved data types that can be used for planning.
Optional<CatalogPartition>	getPartition(ObjectIdentifier tableIdentifier, CatalogPartitionSpec partitionSpec) Retrieves a partition with a fully qualified table path and partition spec.
SchemaResolver	getSchemaResolver() Returns a SchemaResolver for creating ResolvedSchema from Schema.
Optional<ContextResolvedTable>	getTable(ObjectIdentifier objectIdentifier) Retrieves a fully qualified table.
ContextResolvedTable	getTableOrError(ObjectIdentifier objectIdentifier) Like getTable(ObjectIdentifier), but throws an error when the table is not available in any of the catalogs.
protected Optional<TemporaryOperationListener>	getTemporaryOperationListener(ObjectIdentifier identifier)
void	initSchemaResolver(boolean isStreamingMode, ExpressionResolver.ExpressionResolverBuilder expressionResolverBuilder) Initializes a SchemaResolver for Schema resolution.
Set<String>	listCatalogs() Retrieves names of all registered catalogs.
Set<String>	listSchemas() Lists all available schemas in the root of the catalog manager.
Set<String>	listSchemas(String catalogName) Lists all available schemas in the given catalog.
Set<String>	listTables() Returns an array of names of all tables (tables and views, both temporary and permanent) registered in the namespace of the current catalog and database.
Set<String>	listTables(String catalogName, String databaseName) Returns an array of names of all tables (tables and views, both temporary and permanent) registered in the namespace of the given catalog and database.
Set<String>	listTemporaryTables() Returns an array of names of temporary tables registered in the namespace of the current catalog and database.
Set<String>	listTemporaryViews() Returns an array of names of temporary views registered in the namespace of the current catalog and database.
Set<String>	listViews() Returns an array of names of all views(both temporary and permanent) registered in the namespace of the current catalog and database.
Set<String>	listViews(String catalogName, String databaseName) Returns an array of names of all views(both temporary and permanent) registered in the namespace of the given catalog and database.
static CatalogManager.Builder	newBuilder()
ObjectIdentifier	qualifyIdentifier(UnresolvedIdentifier identifier) Returns the full name of the given table path, this name may be padded with current catalog/database name based on the identifier's length.
void	registerCatalog(String catalogName, Catalog catalog) Registers a catalog under the given name.
ResolvedCatalogBaseTable<?>	resolveCatalogBaseTable(CatalogBaseTable baseTable) Resolves a CatalogBaseTable to a validated ResolvedCatalogBaseTable.
ResolvedCatalogTable	resolveCatalogTable(CatalogTable table) Resolves a CatalogTable to a validated ResolvedCatalogTable.
ResolvedCatalogView	resolveCatalogView(CatalogView view) Resolves a CatalogView to a validated ResolvedCatalogView.
Map<String,String>	resolveCompactManagedTableOptions(ResolvedCatalogTable origin, ObjectIdentifier tableIdentifier, CatalogPartitionSpec partitionSpec) Resolve dynamic options for compact operation on a Flink's managed table.
boolean	schemaExists(String catalogName) Checks if there is a catalog with given name or is there a temporary object registered within a given catalog.
boolean	schemaExists(String catalogName, String databaseName) Checks if there is a database with given name in a given catalog or is there a temporary object registered within a given catalog and database.
void	setCurrentCatalog(String catalogName) Sets the current catalog name that will be used when resolving table path.
void	setCurrentDatabase(String databaseName) Sets the current database name that will be used when resolving a table path.
void	unregisterCatalog(String catalogName, boolean ignoreIfNotExists) Unregisters a catalog under the given name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newBuilder

public static CatalogManager.Builder newBuilder()

initSchemaResolver

public void initSchemaResolver(boolean isStreamingMode,
                               ExpressionResolver.ExpressionResolverBuilder expressionResolverBuilder)

Initializes a SchemaResolver for Schema resolution.

Currently, the resolver cannot be passed in the constructor because of a chicken-and-egg problem between Planner and CatalogManager.

See Also:

TableEnvironmentImpl.create(EnvironmentSettings)

getSchemaResolver

public SchemaResolver getSchemaResolver()

Returns a SchemaResolver for creating ResolvedSchema from Schema.

getDataTypeFactory

public DataTypeFactory getDataTypeFactory()

Returns a factory for creating fully resolved data types that can be used for planning.

registerCatalog

public void registerCatalog(String catalogName,
                            Catalog catalog)

Registers a catalog under the given name. The catalog name must be unique.

Parameters:

catalogName - name under which to register the given catalog

catalog - catalog to register

Throws:

CatalogException - if the registration of the catalog under the given name failed

unregisterCatalog

public void unregisterCatalog(String catalogName,
                              boolean ignoreIfNotExists)

Unregisters a catalog under the given name. The catalog name must be existed.

Parameters:

catalogName - name under which to unregister the given catalog.

ignoreIfNotExists - If false exception will be thrown if the table or database or catalog to be altered does not exist.

Throws:

CatalogException - if the unregistration of the catalog under the given name failed

getCatalog

public Optional<Catalog> getCatalog(String catalogName)

Gets a catalog by name.

Parameters:

catalogName - name of the catalog to retrieve

Returns:

the requested catalog or empty if it does not exist

getCurrentCatalog

public String getCurrentCatalog()

Gets the current catalog that will be used when resolving table path.

Returns:

the current catalog

See Also:

qualifyIdentifier(UnresolvedIdentifier)

setCurrentCatalog

public void setCurrentCatalog(String catalogName)
                       throws CatalogNotExistException

Sets the current catalog name that will be used when resolving table path.

Parameters:

catalogName - catalog name to set as current catalog

Throws:

CatalogNotExistException - thrown if the catalog doesn't exist

See Also:

qualifyIdentifier(UnresolvedIdentifier)

getCurrentDatabase

public String getCurrentDatabase()

Gets the current database name that will be used when resolving table path.

Returns:

the current database

See Also:

qualifyIdentifier(UnresolvedIdentifier)

setCurrentDatabase

public void setCurrentDatabase(String databaseName)

Sets the current database name that will be used when resolving a table path. The database has to exist in the current catalog.

Parameters:

databaseName - database name to set as current database name

Throws:

CatalogException - thrown if the database doesn't exist in the current catalog

See Also:

qualifyIdentifier(UnresolvedIdentifier), setCurrentCatalog(String)

getBuiltInCatalogName

public String getBuiltInCatalogName()

Gets the built-in catalog name. The built-in catalog is used for storing all non-serializable transient meta-objects.

Returns:

the built-in catalog name

getBuiltInDatabaseName

public String getBuiltInDatabaseName()

Gets the built-in database name in the built-in catalog. The built-in database is used for storing all non-serializable transient meta-objects.

Returns:

the built-in database name

getTable

public Optional<ContextResolvedTable> getTable(ObjectIdentifier objectIdentifier)

Retrieves a fully qualified table. If the path is not yet fully qualified use qualifyIdentifier(UnresolvedIdentifier) first.

Parameters:

objectIdentifier - full path of the table to retrieve

Returns:

table that the path points to.

getTableOrError

public ContextResolvedTable getTableOrError(ObjectIdentifier objectIdentifier)

Like getTable(ObjectIdentifier), but throws an error when the table is not available in any of the catalogs.

getPartition

public Optional<CatalogPartition> getPartition(ObjectIdentifier tableIdentifier,
                                               CatalogPartitionSpec partitionSpec)

Retrieves a partition with a fully qualified table path and partition spec. If the path is not yet fully qualified usequalifyIdentifier(UnresolvedIdentifier) first.

Parameters:

tableIdentifier - full path of the table to retrieve

partitionSpec - full partition spec

Returns:

partition in the table.

listCatalogs

public Set<String> listCatalogs()

Retrieves names of all registered catalogs.

Returns:

a set of names of registered catalogs

listTables

public Set<String> listTables()

Returns an array of names of all tables (tables and views, both temporary and permanent) registered in the namespace of the current catalog and database.

Returns:

names of all registered tables

listTables

public Set<String> listTables(String catalogName,
                              String databaseName)

Returns an array of names of all tables (tables and views, both temporary and permanent) registered in the namespace of the given catalog and database.

Returns:

names of all registered tables

listTemporaryTables

public Set<String> listTemporaryTables()

Returns an array of names of temporary tables registered in the namespace of the current catalog and database.

Returns:

names of registered temporary tables

listTemporaryViews

public Set<String> listTemporaryViews()

Returns an array of names of temporary views registered in the namespace of the current catalog and database.

Returns:

names of registered temporary views

listViews

public Set<String> listViews()

Returns an array of names of all views(both temporary and permanent) registered in the namespace of the current catalog and database.

Returns:

names of all registered views

listViews

public Set<String> listViews(String catalogName,
                             String databaseName)

Returns an array of names of all views(both temporary and permanent) registered in the namespace of the given catalog and database.

Returns:

names of registered views

listSchemas

public Set<String> listSchemas()

Lists all available schemas in the root of the catalog manager. It is not equivalent to listing all catalogs as it includes also different catalog parts of the temporary objects.

NOTE:It is primarily used for interacting with Calcite's schema.

Returns:

list of schemas in the root of catalog manager

listSchemas

public Set<String> listSchemas(String catalogName)

Lists all available schemas in the given catalog. It is not equivalent to listing databases within the given catalog as it includes also different database parts of the temporary objects identifiers.

NOTE:It is primarily used for interacting with Calcite's schema.

Parameters:

catalogName - filter for the catalog part of the schema

Returns:

list of schemas with the given prefix

schemaExists

public boolean schemaExists(String catalogName)

Checks if there is a catalog with given name or is there a temporary object registered within a given catalog.

NOTE:It is primarily used for interacting with Calcite's schema.

Parameters:

catalogName - filter for the catalog part of the schema

Returns:

true if a subschema exists

schemaExists

public boolean schemaExists(String catalogName,
                            String databaseName)

Checks if there is a database with given name in a given catalog or is there a temporary object registered within a given catalog and database.

NOTE:It is primarily used for interacting with Calcite's schema.

Parameters:

catalogName - filter for the catalog part of the schema

databaseName - filter for the database part of the schema

Returns:

true if a subschema exists

qualifyIdentifier

public ObjectIdentifier qualifyIdentifier(UnresolvedIdentifier identifier)

Returns the full name of the given table path, this name may be padded with current catalog/database name based on the identifier's length.

Parameters:

identifier - an unresolved identifier

Returns:

a fully qualified object identifier

createTable

public void createTable(CatalogBaseTable table,
                        ObjectIdentifier objectIdentifier,
                        boolean ignoreIfExists)

Creates a table in a given fully qualified path.

Parameters:

table - The table to put in the given path.

objectIdentifier - The fully qualified path where to put the table.

ignoreIfExists - If false exception will be thrown if a table exists in the given path.

createTemporaryTable

public void createTemporaryTable(CatalogBaseTable table,
                                 ObjectIdentifier objectIdentifier,
                                 boolean ignoreIfExists)

Creates a temporary table in a given fully qualified path.

Parameters:

table - The table to put in the given path.

objectIdentifier - The fully qualified path where to put the table.

ignoreIfExists - if false exception will be thrown if a table exists in the given path.

resolveCompactManagedTableOptions

public Map<String,String> resolveCompactManagedTableOptions(ResolvedCatalogTable origin,
                                                            ObjectIdentifier tableIdentifier,
                                                            CatalogPartitionSpec partitionSpec)

Resolve dynamic options for compact operation on a Flink's managed table.

Parameters:

origin - The resolved managed table with enriched options.

tableIdentifier - The fully qualified path of the managed table.

partitionSpec - User-specified unresolved partition spec.

Returns:

dynamic options which describe the metadata of compaction

dropTemporaryTable

public void dropTemporaryTable(ObjectIdentifier objectIdentifier,
                               boolean ignoreIfNotExists)

Drop a temporary table in a given fully qualified path.

Parameters:

objectIdentifier - The fully qualified path of the table to drop.

ignoreIfNotExists - If false exception will be thrown if the table to be dropped does not exist.

dropTemporaryView

public void dropTemporaryView(ObjectIdentifier objectIdentifier,
                              boolean ignoreIfNotExists)

Drop a temporary view in a given fully qualified path.

Parameters:

objectIdentifier - The fully qualified path of the view to drop.

ignoreIfNotExists - If false exception will be thrown if the view to be dropped does not exist.

getTemporaryOperationListener

protected Optional<TemporaryOperationListener> getTemporaryOperationListener(ObjectIdentifier identifier)

alterTable

public void alterTable(CatalogBaseTable table,
                       ObjectIdentifier objectIdentifier,
                       boolean ignoreIfNotExists)

Alters a table in a given fully qualified path.

Parameters:

table - The table to put in the given path

objectIdentifier - The fully qualified path where to alter the table.

ignoreIfNotExists - If false exception will be thrown if the table or database or catalog to be altered does not exist.

alterTable

public void alterTable(CatalogBaseTable table,
                       List<TableChange> changes,
                       ObjectIdentifier objectIdentifier,
                       boolean ignoreIfNotExists)

Alters a table in a given fully qualified path with table changes.

Parameters:

table - The table to put in the given path

changes - The table changes from the original table to the new table.

objectIdentifier - The fully qualified path where to alter the table.

ignoreIfNotExists - If false exception will be thrown if the table or database or catalog to be altered does not exist.

dropTable

public void dropTable(ObjectIdentifier objectIdentifier,
                      boolean ignoreIfNotExists)

Drops a table in a given fully qualified path.

Parameters:

objectIdentifier - The fully qualified path of the table to drop.

ignoreIfNotExists - If false exception will be thrown if the table to drop does not exist.

dropView

public void dropView(ObjectIdentifier objectIdentifier,
                     boolean ignoreIfNotExists)

Drops a view in a given fully qualified path.

Parameters:

objectIdentifier - The fully qualified path of the view to drop.

ignoreIfNotExists - If false exception will be thrown if the view to drop does not exist.

resolveCatalogBaseTable

public ResolvedCatalogBaseTable<?> resolveCatalogBaseTable(CatalogBaseTable baseTable)

Resolves a CatalogBaseTable to a validated ResolvedCatalogBaseTable.

resolveCatalogTable

public ResolvedCatalogTable resolveCatalogTable(CatalogTable table)

Resolves a CatalogTable to a validated ResolvedCatalogTable.

resolveCatalogView

public ResolvedCatalogView resolveCatalogView(CatalogView view)

Resolves a CatalogView to a validated ResolvedCatalogView.