org.apache.paimon.catalog

Interface SupportsBranches

All Superinterfaces:

AutoCloseable, Catalog

public interface SupportsBranches
extends Catalog

A Catalog supports creating and dropping table branches.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.paimon.catalog.Catalog

Catalog.ColumnAlreadyExistException, Catalog.ColumnNotExistException, Catalog.DatabaseAlreadyExistException, Catalog.DatabaseNoPermissionException, Catalog.DatabaseNotEmptyException, Catalog.DatabaseNotExistException, Catalog.ProcessSystemDatabaseException, Catalog.TableAlreadyExistException, Catalog.TableNoPermissionException, Catalog.TableNotExistException, Catalog.ViewAlreadyExistException, Catalog.ViewNotExistException

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	createBranch(Identifier identifier, String branch, String fromTag) Create a new branch for this table.
void	dropBranch(Identifier identifier, String branch) Drop the branch for this table.
void	fastForward(Identifier identifier, String branch) Fast-forward a branch to main branch.
List<String>	listBranches(Identifier identifier) List all branches of the table.

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

alterDatabase, alterPartitions, alterTable, alterTable, caseSensitive, catalogLoader, createDatabase, createDatabase, createPartitions, createTable, createView, dropDatabase, dropPartitions, dropTable, dropView, getDatabase, getTable, getView, invalidateTable, listDatabases, listPartitions, listTables, listViews, markDonePartitions, options, renameTable, renameView, repairCatalog, repairDatabase, repairTable

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

createBranch

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

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.

Parameters:

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

branch - the branch name

fromTag - from the tag

Throws:

TableNotExistException - if the table in identifier doesn't exist

DatabaseNotExistException - if the database in identifier doesn't exist

Catalog.TableNotExistException

Catalog.DatabaseNotExistException

dropBranch

void dropBranch(Identifier identifier,
                String branch)
         throws Catalog.TableNotExistException,
                Catalog.DatabaseNotExistException

Drop the branch for this table.

Parameters:

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

branch - the branch name

Throws:

TableNotExistException - if the table in identifier doesn't exist

DatabaseNotExistException - if the database in identifier doesn't exist

Catalog.TableNotExistException

Catalog.DatabaseNotExistException

fastForward

void fastForward(Identifier identifier,
                 String branch)
          throws Catalog.TableNotExistException,
                 Catalog.DatabaseNotExistException

Fast-forward a branch to main branch.

Parameters:

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

branch - the branch name

Throws:

TableNotExistException - if the table in identifier doesn't exist

DatabaseNotExistException - if the database in identifier doesn't exist

Catalog.TableNotExistException

Catalog.DatabaseNotExistException

listBranches

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

List all branches of the table.

Parameters:

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

Throws:

TableNotExistException - if the table in identifier doesn't exist

DatabaseNotExistException - if the database in identifier doesn't exist

Catalog.TableNotExistException

Catalog.DatabaseNotExistException