org.apache.paimon.catalog

Class FileSystemCatalog

java.lang.Object

org.apache.paimon.catalog.AbstractCatalog

org.apache.paimon.catalog.FileSystemCatalog

All Implemented Interfaces:

AutoCloseable, Catalog

public class FileSystemCatalog
extends AbstractCatalog

A catalog implementation for FileIO.

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

Constructor and Description
FileSystemCatalog(FileIO fileIO, Path warehouse)
FileSystemCatalog(FileIO fileIO, Path warehouse, Options options)

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)
void	createTableImpl(Identifier identifier, Schema schema)
protected void	dropDatabaseImpl(String name)
protected void	dropTableImpl(Identifier identifier)
TableSchema	getDataTableSchema(Identifier identifier)
List<String>	listDatabases() Get the names of all databases in this catalog.
protected List<String>	listTablesImpl(String databaseName)
Map<String,String>	loadDatabasePropertiesImpl(String name)
void	renameTableImpl(Identifier fromTable, Identifier toTable)
boolean	tableExists(Identifier identifier) Check if a table exists in this catalog.
protected static <T> T	uncheck(Callable<T> callable)
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, defaultLockFactory, dropDatabase, dropPartition, dropTable, fileIO, getFormatTable, getTable, getTableLocation, isSpecifiedSystemTable, isSystemDatabase, isSystemTable, listDatabasesInFileSystem, listTables, listTablesInFileSystem, loadDatabaseProperties, lockContext, 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, validateCaseInsensitive, validateCaseInsensitive

Constructor Detail

FileSystemCatalog

public FileSystemCatalog(FileIO fileIO,
                         Path warehouse)

FileSystemCatalog

public FileSystemCatalog(FileIO fileIO,
                         Path warehouse,
                         Options options)

Method Detail

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

createDatabaseImpl

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

Specified by:

createDatabaseImpl in class AbstractCatalog

loadDatabasePropertiesImpl

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

Specified by:

loadDatabasePropertiesImpl in class AbstractCatalog

Throws:

Catalog.DatabaseNotExistException

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

tableExists

public boolean tableExists(Identifier identifier)

Description copied from interface: Catalog

Check if a table exists in this catalog.

Parameters:

identifier - Path of the table

Returns:

true if the given table exists in the catalog false otherwise

getDataTableSchema

public TableSchema getDataTableSchema(Identifier identifier)
                               throws Catalog.TableNotExistException

Specified by:

getDataTableSchema in class AbstractCatalog

Throws:

Catalog.TableNotExistException

dropTableImpl

protected void dropTableImpl(Identifier identifier)

Specified by:

dropTableImpl in class AbstractCatalog

createTableImpl

public void createTableImpl(Identifier identifier,
                            Schema schema)

Specified by:

createTableImpl in class AbstractCatalog

renameTableImpl

public 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

uncheck

protected static <T> T uncheck(Callable<T> callable)

close

public void close()
           throws Exception

Throws:

Exception

warehouse

public String warehouse()

Description copied from interface: Catalog

Warehouse root path containing all database directories in this catalog.

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