org.apache.paimon.catalog

Class AbstractCatalog

java.lang.Object

org.apache.paimon.catalog.AbstractCatalog

All Implemented Interfaces:

AutoCloseable, Catalog

Direct Known Subclasses:

FileSystemCatalog, HiveCatalog, JdbcCatalog

public abstract class AbstractCatalog
extends Object
implements Catalog

Common implementation of 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
protected Options	catalogOptions
protected FileIO	fileIO
protected Map<String,String>	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	AbstractCatalog(FileIO fileIO)
protected	AbstractCatalog(FileIO fileIO, Options options)

Method Summary

Modifier and Type	Method and Description
protected boolean	allowCustomTablePath()
void	alterDatabase(String name, List<PropertyChange> changes, boolean ignoreIfNotExists) Alter a database.
protected abstract void	alterDatabaseImpl(String name, List<PropertyChange> changes)
void	alterPartitions(Identifier identifier, List<PartitionStatistics> partitions) Alter partitions of the specify table.
void	alterTable(Identifier identifier, List<SchemaChange> changes, boolean ignoreIfNotExists) Modify an existing table from SchemaChanges.
protected abstract void	alterTableImpl(Identifier identifier, List<SchemaChange> changes)
protected void	assertMainBranch(Identifier identifier)
boolean	commitSnapshot(Identifier identifier, Snapshot snapshot, List<PartitionStatistics> statistics) Commit the Snapshot for table identified by the given Identifier.
void	createBranch(Identifier identifier, String branch, String fromTag) Create a new branch for this table.
void	createDatabase(String name, boolean ignoreIfExists, Map<String,String> properties) Create a database with properties.
protected abstract void	createDatabaseImpl(String name, Map<String,String> properties)
void	createFormatTable(Identifier identifier, Schema schema) Create a FormatTable identified by the given Identifier.
void	createPartitions(Identifier identifier, List<Map<String,String>> partitions) Create partitions of the specify table.
void	createTable(Identifier identifier, Schema schema, boolean ignoreIfExists) Create a new table.
protected abstract void	createTableImpl(Identifier identifier, Schema schema)
Optional<CatalogLockFactory>	defaultLockFactory()
void	dropBranch(Identifier identifier, String branch) Drop the branch for this table.
void	dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade) Drop a database.
protected abstract void	dropDatabaseImpl(String name)
void	dropPartitions(Identifier identifier, List<Map<String,String>> partitions) Drop partitions of the specify table.
void	dropTable(Identifier identifier, boolean ignoreIfNotExists) Drop a table.
protected abstract void	dropTableImpl(Identifier identifier, List<Path> externalPaths)
void	fastForward(Identifier identifier, String branch) Fast-forward a branch to main branch.
FileIO	fileIO()
protected FileIO	fileIO(Path path)
Database	getDatabase(String name) Return a Database identified by the given name.
protected abstract Database	getDatabaseImpl(String name)
Table	getTable(Identifier identifier) Return a Table identified by the given Identifier.
Path	getTableLocation(Identifier identifier)
List<String>	listBranches(Identifier identifier) List all branches of the table.
protected List<String>	listDatabasesInFileSystem(Path warehouse)
PagedList<String>	listDatabasesPaged(Integer maxResults, String pageToken) Get paged list names of all databases in this catalog.
List<Partition>	listPartitions(Identifier identifier) Get Partition of all partitions of the table.
PagedList<Partition>	listPartitionsPaged(Identifier identifier, Integer maxResults, String pageToken) Get paged partitioned list of the table.
PagedList<Table>	listTableDetailsPaged(String databaseName, Integer maxResults, String pageToken) Get paged list of table details under this database.
protected PagedList<Table>	listTableDetailsPagedImpl(String databaseName, Integer maxResults, String pageToken)
List<String>	listTables(String databaseName) Get names of all tables under this database.
protected abstract List<String>	listTablesImpl(String databaseName)
protected List<String>	listTablesInFileSystem(Path databasePath)
PagedList<String>	listTablesPaged(String databaseName, Integer maxResults, String pageToken) Get paged list names of tables under this database.
Optional<TableSnapshot>	loadSnapshot(Identifier identifier) Return the snapshot of table identified by the given Identifier.
protected TableMetadata	loadTableMetadata(Identifier identifier)
protected abstract TableSchema	loadTableSchema(Identifier identifier)
Optional<CatalogLockContext>	lockContext()
protected boolean	lockEnabled()
Optional<CatalogLockFactory>	lockFactory()
void	markDonePartitions(Identifier identifier, List<Map<String,String>> partitions) Mark partitions done of the specify table.
Path	newDatabasePath(String database) Get warehouse path for specified database.
static Path	newDatabasePath(String warehouse, String database)
static Path	newTableLocation(String warehouse, Identifier identifier)
Map<String,String>	options() Catalog options for re-creating this catalog.
void	renameTable(Identifier fromTable, Identifier toTable, boolean ignoreIfNotExists) Rename a table.
protected abstract void	renameTableImpl(Identifier fromTable, Identifier toTable)
void	rollbackTo(Identifier identifier, Instant instant) rollback table by the given Identifier and instant.
boolean	supportsListObjectsPaged() Whether this catalog supports version management for tables.
boolean	supportsVersionManagement() Whether this catalog supports version management for tables.
protected boolean	tableExistsInFileSystem(Path tablePath, String branchName)
Optional<TableSchema>	tableSchemaInFileSystem(Path tablePath, String branchName)
abstract String	warehouse()

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

fileIO

protected final FileIO fileIO

tableDefaultOptions

protected final Map<String,String> tableDefaultOptions

catalogOptions

protected final Options catalogOptions

Constructor Detail

AbstractCatalog

protected AbstractCatalog(FileIO fileIO)

AbstractCatalog

protected AbstractCatalog(FileIO fileIO,
                          Options options)

Method Detail

options

public Map<String,String> options()

Description copied from interface: Catalog

Catalog options for re-creating this catalog.

Specified by:

options in interface Catalog

warehouse

public abstract String warehouse()

fileIO

public FileIO fileIO()

fileIO

protected FileIO fileIO(Path path)

lockFactory

public Optional<CatalogLockFactory> lockFactory()

defaultLockFactory

public Optional<CatalogLockFactory> defaultLockFactory()

lockContext

public Optional<CatalogLockContext> lockContext()

lockEnabled

protected boolean lockEnabled()

allowCustomTablePath

protected boolean allowCustomTablePath()

listDatabasesPaged

public PagedList<String> listDatabasesPaged(Integer maxResults,
                                            String pageToken)

Description copied from interface: Catalog

Get paged list names of all databases in this catalog.

Specified by:

listDatabasesPaged in interface Catalog

Parameters:

maxResults - Optional parameter indicating the maximum number of results to include in the result. If maxResults is not specified or set to 0, will return the default number of max results.

pageToken - Optional parameter indicating the next page token allows list to be start from a specific point.

Returns:

a list of the names of databases with provided page size in this catalog and next page token, or a list of the names of all databases if the catalog does not Catalog.supportsListObjectsPaged().

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

getDatabase

public Database getDatabase(String name)
                     throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Return a Database identified by the given name.

Specified by:

getDatabase in interface Catalog

Parameters:

name - Database name

Returns:

The requested Database

Throws:

Catalog.DatabaseNotExistException - if the requested database does not exist

getDatabaseImpl

protected abstract Database getDatabaseImpl(String name)
                                     throws Catalog.DatabaseNotExistException

Throws:

Catalog.DatabaseNotExistException

markDonePartitions

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

Description copied from interface: Catalog

Mark partitions done of the specify table. For non-existent partitions, partitions will be created directly.

Specified by:

markDonePartitions in interface Catalog

Parameters:

identifier - path of the table to mark done partitions

partitions - partitions to be marked done

Throws:

Catalog.TableNotExistException - if the table does not exist

listPartitions

public List<Partition> listPartitions(Identifier identifier)
                               throws Catalog.TableNotExistException

Description copied from interface: Catalog

Get Partition of all partitions of the table.

Specified by:

listPartitions in interface Catalog

Parameters:

identifier - path of the table to list partitions

Throws:

Catalog.TableNotExistException - if the table does not exist

listPartitionsPaged

public PagedList<Partition> listPartitionsPaged(Identifier identifier,
                                                Integer maxResults,
                                                String pageToken)
                                         throws Catalog.TableNotExistException

Description copied from interface: Catalog

Get paged partitioned list of the table.

Specified by:

listPartitionsPaged in interface Catalog

Parameters:

identifier - path of the table to list partitions

maxResults - Optional parameter indicating the maximum number of results to include in the result. If maxResults is not specified or set to 0, will return the default number of max results.

pageToken - Optional parameter indicating the next page token allows list to be start from a specific point.

Returns:

a list of the partitions with provided page size(@param maxResults) in this table and next page token, or a list of all partitions of the table if the catalog does not Catalog.supportsListObjectsPaged().

Throws:

Catalog.TableNotExistException - if the table does not exist

createDatabaseImpl

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

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

dropDatabaseImpl

protected abstract void dropDatabaseImpl(String name)

alterDatabase

public void alterDatabase(String name,
                          List<PropertyChange> changes,
                          boolean ignoreIfNotExists)
                   throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Alter a database.

Specified by:

alterDatabase in interface Catalog

Parameters:

name - Name of the database to alter.

changes - the property changes

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

Throws:

Catalog.DatabaseNotExistException - if the given database is not exist and ignoreIfNotExists is false

alterDatabaseImpl

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

Throws:

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

listTablesPaged

public PagedList<String> listTablesPaged(String databaseName,
                                         Integer maxResults,
                                         String pageToken)
                                  throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

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

NOTE: System tables will not be listed.

Specified by:

listTablesPaged in interface Catalog

Parameters:

databaseName - Name of the database to list tables.

maxResults - Optional parameter indicating the maximum number of results to include in the result. If maxResults is not specified or set to 0, will return the default number of max results.

pageToken - Optional parameter indicating the next page token allows list to be start from a specific point.

Returns:

a list of the names of tables with provided page size in this database and next page token, or a list of the names of all tables in this database if the catalog does not Catalog.supportsListObjectsPaged().

Throws:

Catalog.DatabaseNotExistException - if the database does not exist

listTableDetailsPaged

public PagedList<Table> listTableDetailsPaged(String databaseName,
                                              Integer maxResults,
                                              String pageToken)
                                       throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Get paged list of table details under this database. An empty list is returned if none exists.

NOTE: System tables will not be listed.

Specified by:

listTableDetailsPaged in interface Catalog

Parameters:

databaseName - Name of the database to list table details.

maxResults - Optional parameter indicating the maximum number of results to include in the result. If maxResults is not specified or set to 0, will return the default number of max results.

pageToken - Optional parameter indicating the next page token allows list to be start from a specific point.

Returns:

a list of the table details with provided page size in this database and next page token, or a list of the details of all tables in this database if the catalog does not Catalog.supportsListObjectsPaged().

Throws:

Catalog.DatabaseNotExistException - if the database does not exist

listTablesImpl

protected abstract List<String> listTablesImpl(String databaseName)

listTableDetailsPagedImpl

protected PagedList<Table> listTableDetailsPagedImpl(String databaseName,
                                                     Integer maxResults,
                                                     String pageToken)
                                              throws Catalog.DatabaseNotExistException

Throws:

Catalog.DatabaseNotExistException

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

dropTableImpl

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

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

createTableImpl

protected abstract void createTableImpl(Identifier identifier,
                                        Schema schema)

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

renameTableImpl

protected abstract void renameTableImpl(Identifier fromTable,
                                        Identifier toTable)

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

alterTableImpl

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

Throws:

Catalog.TableNotExistException

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

createBranch

public void createBranch(Identifier identifier,
                         String branch,
                         @Nullable
                         String fromTag)
                  throws Catalog.TableNotExistException,
                         Catalog.BranchAlreadyExistException,
                         Catalog.TagNotExistException

Description copied from interface: Catalog

Create a new branch for this table. By default, an empty branch will be created using the latest schema. If you provide #fromTag, a branch will be created from the tag and the data files will be inherited from it.

Specified by:

createBranch in interface Catalog

Parameters:

identifier - path of the table, cannot be system or branch name.

branch - the branch name

fromTag - from the tag

Throws:

Catalog.TableNotExistException - if the table in identifier doesn't exist

Catalog.BranchAlreadyExistException - if the branch already exists

Catalog.TagNotExistException - if the tag doesn't exist

dropBranch

public void dropBranch(Identifier identifier,
                       String branch)
                throws Catalog.BranchNotExistException

Description copied from interface: Catalog

Drop the branch for this table.

Specified by:

dropBranch in interface Catalog

Parameters:

identifier - path of the table, cannot be system or branch name.

branch - the branch name

Throws:

Catalog.BranchNotExistException - if the branch doesn't exist

fastForward

public void fastForward(Identifier identifier,
                        String branch)
                 throws Catalog.BranchNotExistException

Description copied from interface: Catalog

Fast-forward a branch to main branch.

Specified by:

fastForward in interface Catalog

Parameters:

identifier - path of the table, cannot be system or branch name.

branch - the branch name

Throws:

Catalog.BranchNotExistException - if the branch doesn't exist

listBranches

public List<String> listBranches(Identifier identifier)
                          throws Catalog.TableNotExistException

Description copied from interface: Catalog

List all branches of the table.

Specified by:

listBranches in interface Catalog

Parameters:

identifier - path of the table, cannot be system or branch name.

Throws:

Catalog.TableNotExistException - if the table in identifier doesn't exist

commitSnapshot

public boolean commitSnapshot(Identifier identifier,
                              Snapshot snapshot,
                              List<PartitionStatistics> statistics)

Description copied from interface: Catalog

Commit the Snapshot for table identified by the given Identifier.

Specified by:

commitSnapshot in interface Catalog

Parameters:

identifier - Path of the table

snapshot - Snapshot to be committed

statistics - statistics information of this change

Returns:

Success or not

loadSnapshot

public Optional<TableSnapshot> loadSnapshot(Identifier identifier)

Description copied from interface: Catalog

Return the snapshot of table identified by the given Identifier.

Specified by:

loadSnapshot in interface Catalog

Parameters:

identifier - Path of the table

Returns:

The requested snapshot of the table

rollbackTo

public void rollbackTo(Identifier identifier,
                       Instant instant)
                throws Catalog.TableNotExistException

Description copied from interface: Catalog

rollback table by the given Identifier and instant.

Specified by:

rollbackTo in interface Catalog

Parameters:

identifier - path of the table

instant - like snapshotId or tagName

Throws:

Catalog.TableNotExistException - if the table does not exist

supportsListObjectsPaged

public boolean supportsListObjectsPaged()

Description copied from interface: Catalog

Whether this catalog supports version management for tables. If not, corresponding methods will fall back to listing all objects. For example, Catalog.listTablesPaged(String, Integer, String) would fall back to Catalog.listTables(String).

• Catalog.listDatabasesPaged(Integer, String).
• Catalog.listTablesPaged(String, Integer, String).
• Catalog.listTableDetailsPaged(String, Integer, String).
• Catalog.listViewsPaged(String, Integer, String).
• Catalog.listViewDetailsPaged(String, Integer, String).
• Catalog.listPartitionsPaged(Identifier, Integer, String).

Specified by:

supportsListObjectsPaged in interface Catalog

supportsVersionManagement

public boolean supportsVersionManagement()

Description copied from interface: Catalog

Whether this catalog supports version management for tables. If not, corresponding methods will throw an UnsupportedOperationException, affect the following methods:

• Catalog.commitSnapshot(Identifier, Snapshot, List).
• Catalog.loadSnapshot(Identifier).
• Catalog.rollbackTo(Identifier, Instant).
• Catalog.createBranch(Identifier, String, String).
• Catalog.dropBranch(Identifier, String).
• Catalog.listBranches(Identifier).

Specified by:

supportsVersionManagement in interface Catalog

createPartitions

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

Description copied from interface: Catalog

Create partitions of the specify table. Ignore existing partitions.

Specified by:

createPartitions in interface Catalog

Parameters:

identifier - path of the table to create partitions

partitions - partitions to be created

Throws:

Catalog.TableNotExistException - if the table does not exist

dropPartitions

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

Description copied from interface: Catalog

Drop partitions of the specify table. Ignore non-existent partitions.

Specified by:

dropPartitions in interface Catalog

Parameters:

identifier - path of the table to drop partitions

partitions - partitions to be deleted

Throws:

Catalog.TableNotExistException - if the table does not exist

alterPartitions

public void alterPartitions(Identifier identifier,
                            List<PartitionStatistics> partitions)
                     throws Catalog.TableNotExistException

Description copied from interface: Catalog

Alter partitions of the specify table. For non-existent partitions, partitions will be created directly.

Specified by:

alterPartitions in interface Catalog

Parameters:

identifier - path of the table to alter partitions

partitions - partitions to be altered

Throws:

Catalog.TableNotExistException - if the table does not exist

createFormatTable

public void createFormatTable(Identifier identifier,
                              Schema schema)

Create a FormatTable identified by the given Identifier.

Parameters:

identifier - Path of the table

schema - Schema of the table

newDatabasePath

public Path newDatabasePath(String database)

Get warehouse path for specified database. If a catalog would like to provide individual path for each database, this method can be `Override` in that catalog.

Parameters:

database - The given database name

Returns:

The warehouse path for the database

loadTableMetadata

protected TableMetadata loadTableMetadata(Identifier identifier)
                                   throws Catalog.TableNotExistException

Throws:

Catalog.TableNotExistException

loadTableSchema

protected abstract TableSchema loadTableSchema(Identifier identifier)
                                        throws Catalog.TableNotExistException

Throws:

Catalog.TableNotExistException

getTableLocation

public Path getTableLocation(Identifier identifier)

assertMainBranch

protected void assertMainBranch(Identifier identifier)

newTableLocation

public static Path newTableLocation(String warehouse,
                                    Identifier identifier)

newDatabasePath

public static Path newDatabasePath(String warehouse,
                                   String database)

listDatabasesInFileSystem

protected List<String> listDatabasesInFileSystem(Path warehouse)
                                          throws IOException

Throws:

IOException

listTablesInFileSystem

protected List<String> listTablesInFileSystem(Path databasePath)
                                       throws IOException

Throws:

IOException

tableExistsInFileSystem

protected boolean tableExistsInFileSystem(Path tablePath,
                                          String branchName)

tableSchemaInFileSystem

public Optional<TableSchema> tableSchemaInFileSystem(Path tablePath,
                                                     String branchName)