org.apache.paimon.jdbc

Class JdbcCatalog

java.lang.Object

org.apache.paimon.catalog.AbstractCatalog

org.apache.paimon.jdbc.JdbcCatalog

All Implemented Interfaces:

AutoCloseable, Catalog

public class JdbcCatalog
extends AbstractCatalog

Support jdbc 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
static String	PROPERTY_PREFIX

Fields inherited from class org.apache.paimon.catalog.AbstractCatalog

catalogOptions, fileIO, lineageMetaFactory, tableDefaultOptions

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

Modifier	Constructor and Description
protected	JdbcCatalog(FileIO fileIO, String catalogKey, Options options, String warehouse)

Method Summary

Modifier and Type	Method and Description
boolean	allowUpperCase() Return a boolean that indicates whether this catalog allow upper case.
protected void	alterTableImpl(Identifier identifier, List<SchemaChange> changes)
void	close()
protected void	createDatabaseImpl(String name, Map<String,String> properties)
protected void	createTableImpl(Identifier identifier, Schema schema)
Optional<CatalogLockFactory>	defaultLockFactory()
protected void	dropDatabaseImpl(String name)
protected void	dropTableImpl(Identifier identifier)
JdbcClientPool	getConnections()
protected TableSchema	getDataTableSchema(Identifier identifier)
List<String>	listDatabases() Get the names of all databases in this catalog.
protected List<String>	listTablesImpl(String databaseName)
protected Map<String,String>	loadDatabasePropertiesImpl(String databaseName)
Optional<CatalogLockContext>	lockContext() Get lock context for lock factory to create a lock.
protected void	renameTableImpl(Identifier fromTable, Identifier toTable)
String	warehouse() Warehouse root path containing all database directories in this catalog.

Methods inherited from class org.apache.paimon.catalog.AbstractCatalog

allTablePaths, alterTable, assertMainBranch, checkNotBranch, checkNotSystemDatabase, checkNotSystemTable, createDatabase, createTable, dropDatabase, dropPartition, dropTable, fileIO, getFormatTable, getTable, getTableLocation, isSpecifiedSystemTable, isSystemDatabase, isSystemTable, listDatabasesInFileSystem, listTables, listTablesInFileSystem, loadDatabaseProperties, lockEnabled, lockFactory, newDatabasePath, newDatabasePath, newTableLocation, options, renameTable, tableExistsInFileSystem, tableSchemaInFileSystem, validateFieldNameCaseInsensitive, validateIdentifierNameCaseInsensitive

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, metastoreClientFactory, repairCatalog, repairDatabase, repairTable, tableDefaultOptions, tableExists, validateCaseInsensitive, validateCaseInsensitive

Field Detail

PROPERTY_PREFIX

public static final String PROPERTY_PREFIX

See Also:

Constant Field Values

Constructor Detail

JdbcCatalog

protected JdbcCatalog(FileIO fileIO,
                      String catalogKey,
                      Options options,
                      String warehouse)

Method Detail

getConnections

@VisibleForTesting
public JdbcClientPool getConnections()

warehouse

public String warehouse()

Description copied from interface: Catalog

Warehouse root path containing all database directories in this catalog.

listDatabases

public List<String> listDatabases()

Description copied from interface: Catalog

Get the names of all databases in this catalog.

Returns:

a list of the names of all databases

loadDatabasePropertiesImpl

protected Map<String,String> loadDatabasePropertiesImpl(String databaseName)
                                                 throws Catalog.DatabaseNotExistException

Specified by:

loadDatabasePropertiesImpl in class AbstractCatalog

Throws:

Catalog.DatabaseNotExistException

createDatabaseImpl

protected void createDatabaseImpl(String name,
                                  Map<String,String> properties)

Specified by:

createDatabaseImpl in class AbstractCatalog

dropDatabaseImpl

protected void dropDatabaseImpl(String name)

Specified by:

dropDatabaseImpl in class AbstractCatalog

listTablesImpl

protected List<String> listTablesImpl(String databaseName)

Specified by:

listTablesImpl in class AbstractCatalog

dropTableImpl

protected void dropTableImpl(Identifier identifier)

Specified by:

dropTableImpl in class AbstractCatalog

createTableImpl

protected void createTableImpl(Identifier identifier,
                               Schema schema)

Specified by:

createTableImpl in class AbstractCatalog

renameTableImpl

protected void renameTableImpl(Identifier fromTable,
                               Identifier toTable)

Specified by:

renameTableImpl in class AbstractCatalog

alterTableImpl

protected void alterTableImpl(Identifier identifier,
                              List<SchemaChange> changes)
                       throws Catalog.TableNotExistException,
                              Catalog.ColumnAlreadyExistException,
                              Catalog.ColumnNotExistException

Specified by:

alterTableImpl in class AbstractCatalog

Throws:

Catalog.TableNotExistException

Catalog.ColumnAlreadyExistException

Catalog.ColumnNotExistException

getDataTableSchema

protected TableSchema getDataTableSchema(Identifier identifier)
                                  throws Catalog.TableNotExistException

Specified by:

getDataTableSchema in class AbstractCatalog

Throws:

Catalog.TableNotExistException

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

Overrides:

allowUpperCase in class AbstractCatalog

defaultLockFactory

public Optional<CatalogLockFactory> defaultLockFactory()

Overrides:

defaultLockFactory in class AbstractCatalog

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

Overrides:

lockContext in class AbstractCatalog

close

public void close()
           throws Exception

Throws:

Exception