org.apache.flink.table.catalog

Class CatalogManager

java.lang.Object

org.apache.flink.table.catalog.CatalogManager

All Implemented Interfaces:

AutoCloseable, CatalogRegistry

@Internal
public final class CatalogManager
extends Object
implements CatalogRegistry, AutoCloseable

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	alterDatabase(String catalogName, String databaseName, org.apache.flink.table.catalog.CatalogDatabase newDatabase, boolean ignoreIfNotExists) Modify an existing database.
void	alterTable(org.apache.flink.table.catalog.CatalogBaseTable table, List<org.apache.flink.table.catalog.TableChange> changes, org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Alters a table in a given fully qualified path with table changes.
void	alterTable(org.apache.flink.table.catalog.CatalogBaseTable table, org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Alters a table in a given fully qualified path.
void	close() Closes the catalog manager and releases its resources.
void	createCatalog(String catalogName, org.apache.flink.table.catalog.CatalogDescriptor catalogDescriptor) Creates a catalog under the given name.
void	createDatabase(String catalogName, String databaseName, org.apache.flink.table.catalog.CatalogDatabase database, boolean ignoreIfExists) Create a database.
void	createTable(org.apache.flink.table.catalog.CatalogBaseTable table, org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier, boolean ignoreIfExists) Creates a table in a given fully qualified path.
void	createTemporaryTable(org.apache.flink.table.catalog.CatalogBaseTable table, org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier, boolean ignoreIfExists) Creates a temporary table in a given fully qualified path.
void	dropDatabase(String catalogName, String databaseName, boolean ignoreIfNotExists, boolean cascade) Drop a database.
void	dropTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Drops a table in a given fully qualified path.
void	dropTemporaryTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Drop a temporary table in a given fully qualified path.
void	dropTemporaryView(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier, boolean ignoreIfNotExists) Drop a temporary view in a given fully qualified path.
void	dropView(org.apache.flink.table.catalog.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<org.apache.flink.table.catalog.Catalog>	getCatalog(String catalogName) Gets a Catalog instance by name.
Optional<org.apache.flink.table.catalog.ResolvedCatalogBaseTable<?>>	getCatalogBaseTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier) Retrieves a fully qualified table.
List<CatalogModificationListener>	getCatalogModificationListeners()
org.apache.flink.table.catalog.Catalog	getCatalogOrError(String catalogName) Gets a catalog by name.
org.apache.flink.table.catalog.Catalog	getCatalogOrThrowException(String catalogName)
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.
org.apache.flink.table.catalog.DataTypeFactory	getDataTypeFactory() Returns a factory for creating fully resolved data types that can be used for planning.
Optional<org.apache.flink.table.catalog.CatalogPartition>	getPartition(org.apache.flink.table.catalog.ObjectIdentifier tableIdentifier, org.apache.flink.table.catalog.CatalogPartitionSpec partitionSpec) Retrieves a partition with a fully qualified table path and partition spec.
org.apache.flink.table.catalog.SchemaResolver	getSchemaResolver() Returns a SchemaResolver for creating ResolvedSchema from Schema.
Optional<ContextResolvedTable>	getTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier) Retrieves a fully qualified table.
Optional<ContextResolvedTable>	getTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier, long timestamp) Retrieves a fully qualified table with a specific time.
ContextResolvedTable	getTableOrError(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier) Like getTable(ObjectIdentifier), but throws an error when the table is not available in any of the catalogs.
protected Optional<org.apache.flink.table.catalog.TemporaryOperationListener>	getTemporaryOperationListener(org.apache.flink.table.catalog.ObjectIdentifier identifier)
void	initSchemaResolver(boolean isStreamingMode, ExpressionResolver.ExpressionResolverBuilder expressionResolverBuilder) Initializes a SchemaResolver for Schema resolution.
boolean	isTemporaryTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier) Return whether the table with a fully qualified table path is temporary or not.
Set<String>	listCatalogs() Retrieves the set of names of all registered catalogs, including all initialized catalogs and all catalogs stored in the CatalogStore.
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()
org.apache.flink.table.catalog.ObjectIdentifier	qualifyIdentifier(org.apache.flink.table.catalog.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, org.apache.flink.table.catalog.Catalog catalog) Deprecated. This method is deprecated and will be removed in a future release. Use createCatalog instead to create a catalog using CatalogDescriptor and store it in the CatalogStore.
org.apache.flink.table.catalog.ResolvedCatalogBaseTable<?>	resolveCatalogBaseTable(org.apache.flink.table.catalog.CatalogBaseTable baseTable) Resolves a CatalogBaseTable to a validated ResolvedCatalogBaseTable.
org.apache.flink.table.catalog.ResolvedCatalogTable	resolveCatalogTable(org.apache.flink.table.catalog.CatalogTable table) Resolves a CatalogTable to a validated ResolvedCatalogTable.
org.apache.flink.table.catalog.ResolvedCatalogView	resolveCatalogView(org.apache.flink.table.catalog.CatalogView view) Resolves a CatalogView to a validated ResolvedCatalogView.
Map<String,String>	resolveCompactManagedTableOptions(org.apache.flink.table.catalog.ResolvedCatalogTable origin, org.apache.flink.table.catalog.ObjectIdentifier tableIdentifier, org.apache.flink.table.catalog.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

getCatalogModificationListeners

@VisibleForTesting
public List<CatalogModificationListener> getCatalogModificationListeners()

newBuilder

public static CatalogManager.Builder newBuilder()

close

public void close()
           throws org.apache.flink.table.catalog.exceptions.CatalogException

Closes the catalog manager and releases its resources.

This method closes all initialized catalogs and the catalog store.

Specified by:

close in interface AutoCloseable

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException - if an error occurs while closing the catalogs or the catalog store

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 org.apache.flink.table.catalog.SchemaResolver getSchemaResolver()

Returns a SchemaResolver for creating ResolvedSchema from Schema.

getDataTypeFactory

public org.apache.flink.table.catalog.DataTypeFactory getDataTypeFactory()

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

createCatalog

public void createCatalog(String catalogName,
                          org.apache.flink.table.catalog.CatalogDescriptor catalogDescriptor)
                   throws org.apache.flink.table.catalog.exceptions.CatalogException

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

Parameters:

catalogName - the given catalog name under which to create the given catalog

catalogDescriptor - catalog descriptor for creating catalog

Throws:

org.apache.flink.table.catalog.exceptions.CatalogException - If the catalog already exists in the catalog store or initialized catalogs, or if an error occurs while creating the catalog or storing the CatalogDescriptor

registerCatalog

@Deprecated
public void registerCatalog(String catalogName,
                                        org.apache.flink.table.catalog.Catalog catalog)

Deprecated. This method is deprecated and will be removed in a future release. Use createCatalog instead to create a catalog using CatalogDescriptor and store it in the CatalogStore.

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:

org.apache.flink.table.catalog.exceptions.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.

If the catalog is in the initialized catalogs, it will be removed from the initialized catalogs. If the catalog is stored in the CatalogStore, it will be removed from the CatalogStore.

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:

org.apache.flink.table.catalog.exceptions.CatalogException - If the catalog does not exist in the initialized catalogs and not in the CatalogStore, or if the remove operation failed.

getCatalog

public Optional<org.apache.flink.table.catalog.Catalog> getCatalog(String catalogName)

Gets a Catalog instance by name.

If the catalog has already been initialized, the initialized instance will be returned directly. Otherwise, the CatalogDescriptor will be obtained from the CatalogStore, and the catalog instance will be initialized.

Parameters:

catalogName - name of the catalog to retrieve

Returns:

the requested catalog or empty if it does not exist

getCatalogOrThrowException

public org.apache.flink.table.catalog.Catalog getCatalogOrThrowException(String catalogName)

getCatalogOrError

public org.apache.flink.table.catalog.Catalog getCatalogOrError(String catalogName)
                                                         throws org.apache.flink.table.api.CatalogNotExistException

Gets a catalog by name.

Specified by:

getCatalogOrError in interface CatalogRegistry

Parameters:

catalogName - name of the catalog to retrieve

Returns:

the requested catalog

Throws:

org.apache.flink.table.api.CatalogNotExistException - if the catalog does not exist

getCurrentCatalog

public String getCurrentCatalog()

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

Specified by:

getCurrentCatalog in interface CatalogRegistry

Returns:

the current catalog

See Also:

qualifyIdentifier(UnresolvedIdentifier)

setCurrentCatalog

public void setCurrentCatalog(@Nullable
                              String catalogName)
                       throws org.apache.flink.table.api.CatalogNotExistException

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

Parameters:

catalogName - catalog name to set as current catalog

Throws:

org.apache.flink.table.api.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.

Specified by:

getCurrentDatabase in interface CatalogRegistry

Returns:

the current database

See Also:

qualifyIdentifier(UnresolvedIdentifier)

setCurrentDatabase

public void setCurrentDatabase(@Nullable
                               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:

org.apache.flink.table.catalog.exceptions.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(org.apache.flink.table.catalog.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.

getTable

public Optional<ContextResolvedTable> getTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier,
                                               long timestamp)

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

Parameters:

objectIdentifier - full path of the table to retrieve

timestamp - Timestamp of the table snapshot, which is milliseconds since 1970-01-01 00:00:00 UTC

Returns:

table at a specific time that the path points to.

getCatalogBaseTable

public Optional<org.apache.flink.table.catalog.ResolvedCatalogBaseTable<?>> getCatalogBaseTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier)

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

Specified by:

getCatalogBaseTable in interface CatalogRegistry

Parameters:

objectIdentifier - full path of the table to retrieve

Returns:

resolved table that the path points to or empty if it does not exist.

isTemporaryTable

public boolean isTemporaryTable(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier)

Return whether the table with a fully qualified table path is temporary or not.

Specified by:

isTemporaryTable in interface CatalogRegistry

Parameters:

objectIdentifier - full path of the table

Returns:

the table is temporary or not.

getTableOrError

public ContextResolvedTable getTableOrError(org.apache.flink.table.catalog.ObjectIdentifier objectIdentifier)

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

getPartition

public Optional<org.apache.flink.table.catalog.CatalogPartition> getPartition(org.apache.flink.table.catalog.ObjectIdentifier tableIdentifier,
                                                                              org.apache.flink.table.catalog.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.

Specified by:

getPartition in interface CatalogRegistry

Parameters:

tableIdentifier - full path of the table to retrieve

partitionSpec - full partition spec

Returns:

partition in the table.

listCatalogs

public Set<String> listCatalogs()

Retrieves the set of names of all registered catalogs, including all initialized catalogs and all catalogs stored in the CatalogStore.

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 org.apache.flink.table.catalog.ObjectIdentifier qualifyIdentifier(org.apache.flink.table.catalog.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.

Specified by:

qualifyIdentifier in interface CatalogRegistry

Parameters:

identifier - an unresolved identifier

Returns:

a fully qualified object identifier

createTable

public void createTable(org.apache.flink.table.catalog.CatalogBaseTable table,
                        org.apache.flink.table.catalog.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(org.apache.flink.table.catalog.CatalogBaseTable table,
                                 org.apache.flink.table.catalog.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(org.apache.flink.table.catalog.ResolvedCatalogTable origin,
                                                            org.apache.flink.table.catalog.ObjectIdentifier tableIdentifier,
                                                            org.apache.flink.table.catalog.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(org.apache.flink.table.catalog.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(org.apache.flink.table.catalog.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<org.apache.flink.table.catalog.TemporaryOperationListener> getTemporaryOperationListener(org.apache.flink.table.catalog.ObjectIdentifier identifier)

alterTable

public void alterTable(org.apache.flink.table.catalog.CatalogBaseTable table,
                       org.apache.flink.table.catalog.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(org.apache.flink.table.catalog.CatalogBaseTable table,
                       List<org.apache.flink.table.catalog.TableChange> changes,
                       org.apache.flink.table.catalog.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(org.apache.flink.table.catalog.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(org.apache.flink.table.catalog.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 org.apache.flink.table.catalog.ResolvedCatalogBaseTable<?> resolveCatalogBaseTable(org.apache.flink.table.catalog.CatalogBaseTable baseTable)

Resolves a CatalogBaseTable to a validated ResolvedCatalogBaseTable.

resolveCatalogTable

public org.apache.flink.table.catalog.ResolvedCatalogTable resolveCatalogTable(org.apache.flink.table.catalog.CatalogTable table)

Resolves a CatalogTable to a validated ResolvedCatalogTable.

resolveCatalogView

public org.apache.flink.table.catalog.ResolvedCatalogView resolveCatalogView(org.apache.flink.table.catalog.CatalogView view)

Resolves a CatalogView to a validated ResolvedCatalogView.

createDatabase

public void createDatabase(String catalogName,
                           String databaseName,
                           org.apache.flink.table.catalog.CatalogDatabase database,
                           boolean ignoreIfExists)
                    throws org.apache.flink.table.catalog.exceptions.DatabaseAlreadyExistException,
                           org.apache.flink.table.catalog.exceptions.CatalogException

Create a database.

Parameters:

catalogName - Name of the catalog for database

databaseName - Name of the database to be created

database - The database definition

ignoreIfExists - Flag to specify behavior when a database with the given name already exists: if set to false, throw a DatabaseAlreadyExistException, if set to true, do nothing.

Throws:

org.apache.flink.table.catalog.exceptions.DatabaseAlreadyExistException - if the given database already exists and ignoreIfExists is false

org.apache.flink.table.catalog.exceptions.CatalogException - in case of any runtime exception

dropDatabase

public void dropDatabase(String catalogName,
                         String databaseName,
                         boolean ignoreIfNotExists,
                         boolean cascade)
                  throws org.apache.flink.table.catalog.exceptions.DatabaseNotExistException,
                         org.apache.flink.table.catalog.exceptions.DatabaseNotEmptyException,
                         org.apache.flink.table.catalog.exceptions.CatalogException

Drop a database.

Parameters:

catalogName - Name of the catalog for database.

databaseName - Name of the database to be dropped.

ignoreIfNotExists - Flag to specify behavior when the database does not exist: if set to false, throw an exception, if set to true, do nothing.

cascade - Flag to specify behavior when the database contains table or function: if set to true, delete all tables and functions in the database and then delete the database, if set to false, throw an exception.

Throws:

org.apache.flink.table.catalog.exceptions.DatabaseNotExistException - if the given database does not exist

org.apache.flink.table.catalog.exceptions.DatabaseNotEmptyException - if the given database is not empty and isRestrict is true

org.apache.flink.table.catalog.exceptions.CatalogException - in case of any runtime exception

alterDatabase

public void alterDatabase(String catalogName,
                          String databaseName,
                          org.apache.flink.table.catalog.CatalogDatabase newDatabase,
                          boolean ignoreIfNotExists)
                   throws org.apache.flink.table.catalog.exceptions.DatabaseNotExistException,
                          org.apache.flink.table.catalog.exceptions.CatalogException

Modify an existing database.

Parameters:

catalogName - Name of the catalog for database

databaseName - Name of the database to be dropped

newDatabase - The new database definition

ignoreIfNotExists - Flag to specify behavior when the given database does not exist: if set to false, throw an exception, if set to true, do nothing.

Throws:

org.apache.flink.table.catalog.exceptions.DatabaseNotExistException - if the given database does not exist

org.apache.flink.table.catalog.exceptions.CatalogException - in case of any runtime exception