org.apache.paimon.catalog

Class DelegateCatalog

java.lang.Object

org.apache.paimon.catalog.DelegateCatalog

All Implemented Interfaces:

AutoCloseable, Catalog

Direct Known Subclasses:

CachingCatalog, PrivilegedCatalog

public class DelegateCatalog
extends Object
implements Catalog

A Catalog to delegate all operations to another Catalog.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.paimon.catalog.Catalog

Catalog.ColumnAlreadyExistException, Catalog.ColumnNotExistException, Catalog.DatabaseAlreadyExistException, Catalog.DatabaseNotEmptyException, Catalog.DatabaseNotExistException, Catalog.Loader, Catalog.PartitionNotExistException, Catalog.ProcessSystemDatabaseException, Catalog.TableAlreadyExistException, Catalog.TableNotExistException

Field Summary

Fields

Modifier and Type	Field and Description
protected Catalog	wrapped

Fields inherited from interface org.apache.paimon.catalog.Catalog

COMMENT_PROP, DB_LOCATION_PROP, DB_SUFFIX, DEFAULT_DATABASE, SYSTEM_BRANCH_PREFIX, SYSTEM_DATABASE_NAME, SYSTEM_TABLE_SPLITTER, TABLE_DEFAULT_OPTION_PREFIX

Constructor Summary

Constructors

Constructor and Description
DelegateCatalog(Catalog wrapped)

Method Summary

Modifier and Type	Method and Description
boolean	allowUpperCase() Return a boolean that indicates whether this catalog allow upper case.
void	alterTable(Identifier identifier, List<SchemaChange> changes, boolean ignoreIfNotExists) Modify an existing table from SchemaChanges.
void	close()
void	createDatabase(String name, boolean ignoreIfExists, Map<String,String> properties) Create a database with properties.
void	createTable(Identifier identifier, Schema schema, boolean ignoreIfExists) Create a new table.
void	dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade) Drop a database.
void	dropPartition(Identifier identifier, Map<String,String> partitions) Drop the partition of the specify table.
void	dropTable(Identifier identifier, boolean ignoreIfNotExists) Drop a table.
FileIO	fileIO()
Table	getTable(Identifier identifier) Return a Table identified by the given Identifier.
Path	getTableLocation(Identifier identifier) Get the table location in this catalog.
List<String>	listDatabases() Get the names of all databases in this catalog.
List<String>	listTables(String databaseName) Get names of all tables under this database.
Map<String,String>	loadDatabaseProperties(String name) Load database properties.
Optional<CatalogLockContext>	lockContext() Get lock context for lock factory to create a lock.
Optional<CatalogLockFactory>	lockFactory() Get lock factory from catalog.
Optional<MetastoreClient.Factory>	metastoreClientFactory(Identifier identifier) Get metastore client factory for the table specified by identifier.
Map<String,String>	options() Catalog options.
void	renameTable(Identifier fromTable, Identifier toTable, boolean ignoreIfNotExists) Rename a table.
void	repairCatalog()
void	repairDatabase(String databaseName)
void	repairTable(Identifier identifier)
String	warehouse() Warehouse root path containing all database directories in this catalog.
Catalog	wrapped()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.paimon.catalog.Catalog

alterTable, createDatabase, databaseExists, invalidateTable, tableDefaultOptions, tableExists, validateCaseInsensitive, validateCaseInsensitive

Field Detail

wrapped

protected final Catalog wrapped

Constructor Detail

DelegateCatalog

public DelegateCatalog(Catalog wrapped)

Method Detail

wrapped

public Catalog wrapped()

allowUpperCase

public boolean allowUpperCase()

Description copied from interface: Catalog

Return a boolean that indicates whether this catalog allow upper case.

Specified by:

allowUpperCase in interface Catalog

warehouse

public String warehouse()

Description copied from interface: Catalog

Warehouse root path containing all database directories in this catalog.

Specified by:

warehouse in interface Catalog

options

public Map<String,String> options()

Description copied from interface: Catalog

Catalog options.

Specified by:

options in interface Catalog

fileIO

public FileIO fileIO()

Specified by:

fileIO in interface Catalog

lockFactory

public Optional<CatalogLockFactory> lockFactory()

Description copied from interface: Catalog

Get lock factory from catalog. Lock is used to support multiple concurrent writes on the object store.

Specified by:

lockFactory in interface Catalog

lockContext

public Optional<CatalogLockContext> lockContext()

Description copied from interface: Catalog

Get lock context for lock factory to create a lock.

Specified by:

lockContext in interface Catalog

metastoreClientFactory

public Optional<MetastoreClient.Factory> metastoreClientFactory(Identifier identifier)

Description copied from interface: Catalog

Get metastore client factory for the table specified by identifier.

Specified by:

metastoreClientFactory in interface Catalog

listDatabases

public List<String> listDatabases()

Description copied from interface: Catalog

Get the names of all databases in this catalog.

Specified by:

listDatabases in interface Catalog

Returns:

a list of the names of all databases

createDatabase

public void createDatabase(String name,
                           boolean ignoreIfExists,
                           Map<String,String> properties)
                    throws Catalog.DatabaseAlreadyExistException

Description copied from interface: Catalog

Create a database with properties.

Specified by:

createDatabase in interface Catalog

Parameters:

name - Name of the database to be created

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.

properties - properties to be associated with the database

Throws:

Catalog.DatabaseAlreadyExistException - if the given database already exists and ignoreIfExists is false

loadDatabaseProperties

public Map<String,String> loadDatabaseProperties(String name)
                                          throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Load database properties.

Specified by:

loadDatabaseProperties in interface Catalog

Parameters:

name - Database name

Returns:

The requested database's properties

Throws:

Catalog.DatabaseNotExistException - if the requested database does not exist

dropDatabase

public void dropDatabase(String name,
                         boolean ignoreIfNotExists,
                         boolean cascade)
                  throws Catalog.DatabaseNotExistException,
                         Catalog.DatabaseNotEmptyException

Description copied from interface: Catalog

Drop a database.

Specified by:

dropDatabase in interface Catalog

Parameters:

name - 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:

Catalog.DatabaseNotEmptyException - if the given database is not empty and isRestrict is true

Catalog.DatabaseNotExistException

listTables

public List<String> listTables(String databaseName)
                        throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Get names of all tables under this database. An empty list is returned if none exists.

NOTE: System tables will not be listed.

Specified by:

listTables in interface Catalog

Returns:

a list of the names of all tables in this database

Throws:

Catalog.DatabaseNotExistException - if the database does not exist

dropTable

public void dropTable(Identifier identifier,
                      boolean ignoreIfNotExists)
               throws Catalog.TableNotExistException

Description copied from interface: Catalog

Drop a table.

NOTE: System tables can not be dropped.

Specified by:

dropTable in interface Catalog

Parameters:

identifier - Path of the table to be dropped

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

Throws:

Catalog.TableNotExistException - if the table does not exist

createTable

public void createTable(Identifier identifier,
                        Schema schema,
                        boolean ignoreIfExists)
                 throws Catalog.TableAlreadyExistException,
                        Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Create a new table.

NOTE: System tables can not be created.

Specified by:

createTable in interface Catalog

Parameters:

identifier - path of the table to be created

schema - the table definition

ignoreIfExists - flag to specify behavior when a table already exists at the given path: if set to false, it throws a TableAlreadyExistException, if set to true, do nothing.

Throws:

Catalog.TableAlreadyExistException - if table already exists and ignoreIfExists is false

Catalog.DatabaseNotExistException - if the database in identifier doesn't exist

renameTable

public void renameTable(Identifier fromTable,
                        Identifier toTable,
                        boolean ignoreIfNotExists)
                 throws Catalog.TableNotExistException,
                        Catalog.TableAlreadyExistException

Description copied from interface: Catalog

Rename a table.

NOTE: If you use object storage, such as S3 or OSS, please use this syntax carefully, because the renaming of object storage is not atomic, and only partial files may be moved in case of failure.

NOTE: System tables can not be renamed.

Specified by:

renameTable in interface Catalog

Parameters:

fromTable - the name of the table which need to rename

toTable - the new table

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

Throws:

Catalog.TableNotExistException - if the fromTable does not exist

Catalog.TableAlreadyExistException - if the toTable already exists

alterTable

public void alterTable(Identifier identifier,
                       List<SchemaChange> changes,
                       boolean ignoreIfNotExists)
                throws Catalog.TableNotExistException,
                       Catalog.ColumnAlreadyExistException,
                       Catalog.ColumnNotExistException

Description copied from interface: Catalog

Modify an existing table from SchemaChanges.

NOTE: System tables can not be altered.

Specified by:

alterTable in interface Catalog

Parameters:

identifier - path of the table to be modified

changes - the schema changes

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

Throws:

Catalog.TableNotExistException - if the table does not exist

Catalog.ColumnAlreadyExistException

Catalog.ColumnNotExistException

getTable

public Table getTable(Identifier identifier)
               throws Catalog.TableNotExistException

Description copied from interface: Catalog

Return a Table identified by the given Identifier.

System tables can be got by '$' splitter.

Specified by:

getTable in interface Catalog

Parameters:

identifier - Path of the table

Returns:

The requested table

Throws:

Catalog.TableNotExistException - if the target does not exist

getTableLocation

public Path getTableLocation(Identifier identifier)

Description copied from interface: Catalog

Get the table location in this catalog. If the table exists, return the location of the table; If the table does not exist, construct the location for table.

Specified by:

getTableLocation in interface Catalog

Returns:

the table location

dropPartition

public void dropPartition(Identifier identifier,
                          Map<String,String> partitions)
                   throws Catalog.TableNotExistException,
                          Catalog.PartitionNotExistException

Description copied from interface: Catalog

Drop the partition of the specify table.

Specified by:

dropPartition in interface Catalog

Parameters:

identifier - path of the table to drop partition

partitions - the partition to be deleted

Throws:

Catalog.TableNotExistException - if the table does not exist

Catalog.PartitionNotExistException - if the partition does not exist

repairCatalog

public void repairCatalog()

Specified by:

repairCatalog in interface Catalog

repairDatabase

public void repairDatabase(String databaseName)

Specified by:

repairDatabase in interface Catalog

repairTable

public void repairTable(Identifier identifier)
                 throws Catalog.TableNotExistException

Specified by:

repairTable in interface Catalog

Throws:

Catalog.TableNotExistException

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception