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.BranchAlreadyExistException, Catalog.BranchNotExistException, Catalog.ColumnAlreadyExistException, Catalog.ColumnNotExistException, Catalog.DatabaseAlreadyExistException, Catalog.DatabaseNoPermissionException, Catalog.DatabaseNotEmptyException, Catalog.DatabaseNotExistException, Catalog.DialectAlreadyExistException, Catalog.DialectNotExistException, Catalog.ProcessSystemDatabaseException, Catalog.TableAlreadyExistException, Catalog.TableNoPermissionException, Catalog.TableNotExistException, Catalog.TagNotExistException, Catalog.ViewAlreadyExistException, Catalog.ViewNotExistException

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_PREFIX

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

catalogOptions, fileIO, tableDefaultOptions

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

COMMENT_PROP, DB_LOCATION_PROP, DB_SUFFIX, DEFAULT_DATABASE, LAST_UPDATE_TIME_PROP, NUM_FILES_PROP, NUM_ROWS_PROP, OWNER_PROP, SYSTEM_BRANCH_PREFIX, SYSTEM_DATABASE_NAME, SYSTEM_TABLE_SPLITTER, TABLE_DEFAULT_OPTION_PREFIX, TOTAL_SIZE_PROP

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
protected void	alterDatabaseImpl(String name, List<PropertyChange> changes)
protected void	alterTableImpl(Identifier identifier, List<SchemaChange> changes)
boolean	caseSensitive() Return a boolean that indicates whether this catalog is case-sensitive.
CatalogLoader	catalogLoader() Serializable loader to create catalog.
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, List<Path> externalPaths)
JdbcClientPool	getConnections()
protected Database	getDatabaseImpl(String databaseName)
List<String>	listDatabases() Get the names of all databases in this catalog.
protected List<String>	listTablesImpl(String databaseName)
protected TableSchema	loadTableSchema(Identifier identifier)
Optional<CatalogLockContext>	lockContext()
protected void	renameTableImpl(Identifier fromTable, Identifier toTable)
<T> T	runWithLock(Identifier identifier, Callable<T> callable)
String	warehouse()

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

allowCustomTablePath, alterDatabase, alterPartitions, alterTable, assertMainBranch, commitSnapshot, createBranch, createDatabase, createFormatTable, createPartitions, createTable, dropBranch, dropDatabase, dropPartitions, dropTable, fastForward, fileIO, fileIO, getDatabase, getTable, getTableLocation, listBranches, listDatabasesInFileSystem, listDatabasesPaged, listPartitions, listPartitionsPaged, listTableDetailsPaged, listTableDetailsPagedImpl, listTables, listTablesInFileSystem, listTablesPaged, loadSnapshot, loadTableMetadata, lockEnabled, lockFactory, markDonePartitions, newDatabasePath, newDatabasePath, newTableLocation, options, renameTable, rollbackTo, supportsListObjectsPaged, supportsVersionManagement, tableExistsInFileSystem, tableSchemaInFileSystem

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, alterView, createDatabase, createView, dropView, getView, invalidateTable, listViewDetailsPaged, listViews, listViewsPaged, renameView, repairCatalog, repairDatabase, repairTable

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()

Specified by:

warehouse in class AbstractCatalog

catalogLoader

public CatalogLoader catalogLoader()

Description copied from interface: Catalog

Serializable loader to create 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

getDatabaseImpl

protected Database getDatabaseImpl(String databaseName)
                            throws Catalog.DatabaseNotExistException

Specified by:

getDatabaseImpl 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

alterDatabaseImpl

protected void alterDatabaseImpl(String name,
                                 List<PropertyChange> changes)

Specified by:

alterDatabaseImpl in class AbstractCatalog

listTablesImpl

protected List<String> listTablesImpl(String databaseName)

Specified by:

listTablesImpl in class AbstractCatalog

dropTableImpl

protected void dropTableImpl(Identifier identifier,
                             List<Path> externalPaths)

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.ColumnAlreadyExistException,
                              Catalog.TableNotExistException,
                              Catalog.ColumnNotExistException

Specified by:

alterTableImpl in class AbstractCatalog

Throws:

Catalog.ColumnAlreadyExistException

Catalog.TableNotExistException

Catalog.ColumnNotExistException

loadTableSchema

protected TableSchema loadTableSchema(Identifier identifier)
                               throws Catalog.TableNotExistException

Specified by:

loadTableSchema in class AbstractCatalog

Throws:

Catalog.TableNotExistException

caseSensitive

public boolean caseSensitive()

Description copied from interface: Catalog

Return a boolean that indicates whether this catalog is case-sensitive.

defaultLockFactory

public Optional<CatalogLockFactory> defaultLockFactory()

Overrides:

defaultLockFactory in class AbstractCatalog

lockContext

public Optional<CatalogLockContext> lockContext()

Overrides:

lockContext in class AbstractCatalog

runWithLock

public <T> T runWithLock(Identifier identifier,
                         Callable<T> callable)
                  throws Exception

Throws:

Exception

close

public void close()
           throws Exception

Throws:

Exception