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

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

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)
void	createTableImpl(Identifier identifier, Schema schema)
protected void	dropDatabaseImpl(String name)
protected void	dropTableImpl(Identifier identifier, List<Path> externalPaths)
Database	getDatabaseImpl(String name)
List<String>	listDatabases() Get the names of all databases in this catalog.
protected List<String>	listTablesImpl(String databaseName)
TableSchema	loadTableSchema(Identifier identifier)
void	renameTableImpl(Identifier fromTable, Identifier toTable)
<T> T	runWithLock(Identifier identifier, Callable<T> callable)
protected static <T> T	uncheck(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, defaultLockFactory, dropBranch, dropDatabase, dropPartitions, dropTable, fastForward, fileIO, fileIO, getDatabase, getTable, getTableLocation, listBranches, listDatabasesInFileSystem, listDatabasesPaged, listPartitions, listPartitionsPaged, listTableDetailsPaged, listTableDetailsPagedImpl, listTables, listTablesInFileSystem, listTablesPaged, loadSnapshot, loadTableMetadata, lockContext, 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

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

getDatabaseImpl

public Database getDatabaseImpl(String name)
                         throws Catalog.DatabaseNotExistException

Specified by:

getDatabaseImpl in class AbstractCatalog

Throws:

Catalog.DatabaseNotExistException

dropDatabaseImpl

protected void dropDatabaseImpl(String name)

Specified by:

dropDatabaseImpl in class AbstractCatalog

alterDatabaseImpl

protected void alterDatabaseImpl(String name,
                                 List<PropertyChange> changes)
                          throws Catalog.DatabaseNotExistException

Specified by:

alterDatabaseImpl in class AbstractCatalog

Throws:

Catalog.DatabaseNotExistException

listTablesImpl

protected List<String> listTablesImpl(String databaseName)

Specified by:

listTablesImpl in class AbstractCatalog

loadTableSchema

public TableSchema loadTableSchema(Identifier identifier)
                            throws Catalog.TableNotExistException

Specified by:

loadTableSchema in class AbstractCatalog

Throws:

Catalog.TableNotExistException

dropTableImpl

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

Specified by:

dropTableImpl in class AbstractCatalog

createTableImpl

public void createTableImpl(Identifier identifier,
                            Schema schema)

Specified by:

createTableImpl in class AbstractCatalog

runWithLock

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

Throws:

Exception

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

Specified by:

warehouse in class AbstractCatalog

catalogLoader

public CatalogLoader catalogLoader()

Description copied from interface: Catalog

Serializable loader to create catalog.

caseSensitive

public boolean caseSensitive()

Description copied from interface: Catalog

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