org.apache.paimon.rest

Class RESTCatalog

java.lang.Object

org.apache.paimon.rest.RESTCatalog

All Implemented Interfaces:

AutoCloseable, Catalog

public class RESTCatalog
extends Object
implements Catalog

A catalog implementation for REST.

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.DefinitionAlreadyExistException, Catalog.DefinitionNotExistException, Catalog.DialectAlreadyExistException, Catalog.DialectNotExistException, Catalog.FunctionAlreadyExistException, Catalog.FunctionNotExistException, Catalog.ProcessSystemDatabaseException, Catalog.TableAlreadyExistException, Catalog.TableNoPermissionException, Catalog.TableNotExistException, Catalog.TagNotExistException, 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_DATABASE_NAME, TABLE_DEFAULT_OPTION_PREFIX, TOTAL_SIZE_PROP

Constructor Summary

Constructors

Constructor and Description
RESTCatalog(CatalogContext context)
RESTCatalog(CatalogContext context, boolean configRequired)

Method Summary

Modifier and Type	Method and Description
void	alterDatabase(String name, List<PropertyChange> changes, boolean ignoreIfNotExists) Alter a database.
void	alterFunction(Identifier identifier, List<FunctionChange> changes, boolean ignoreIfNotExists) Alter function.
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.
void	alterView(Identifier identifier, List<ViewChange> viewChanges, boolean ignoreIfNotExists) Alter a view.
List<String>	authTableQuery(Identifier identifier, List<String> select) Auth table query select and get the filter for row level access control.
boolean	caseSensitive() Return a boolean that indicates whether this catalog is case-sensitive.
RESTCatalogLoader	catalogLoader() Serializable loader to create catalog.
void	close()
boolean	commitSnapshot(Identifier identifier, String tableUuid, 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.
void	createFunction(Identifier identifier, Function function, boolean ignoreIfExists) Create a new function.
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.
void	createView(Identifier identifier, View view, boolean ignoreIfExists) Create a new view.
void	dropBranch(Identifier identifier, String branch) Drop the branch for this table.
void	dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade) Drop a database.
void	dropFunction(Identifier identifier, boolean ignoreIfNotExists) Drop function.
void	dropPartitions(Identifier identifier, List<Map<String,String>> partitions) Drop partitions of the specify table.
void	dropTable(Identifier identifier, boolean ignoreIfNotExists) Drop a table.
void	dropView(Identifier identifier, boolean ignoreIfNotExists) Drop a view.
void	fastForward(Identifier identifier, String branch) Fast-forward a branch to main branch.
Database	getDatabase(String name) Return a Database identified by the given name.
Function	getFunction(Identifier identifier) Get function by name.
Table	getTable(Identifier identifier) Return a Table identified by the given Identifier.
View	getView(Identifier identifier) Return a View identified by the given Identifier.
List<String>	listBranches(Identifier identifier) List all branches of the table.
List<String>	listDatabases() Get the names of all databases in this catalog.
PagedList<String>	listDatabasesPaged(Integer maxResults, String pageToken, String databaseNamePattern) Get paged list names of all databases in this catalog.
List<String>	listFunctions(String databaseName) Get the names of all functions 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, String partitionNamePattern) Get paged partition list of the table, the partition list will be returned in descending order.
PagedList<Snapshot>	listSnapshotsPaged(Identifier identifier, Integer maxResults, String pageToken) Get paged snapshot list of the table, the snapshot list will be returned in descending order.
PagedList<Table>	listTableDetailsPaged(String db, Integer maxResults, String pageToken, String tableNamePattern) Get paged list of table details under this database.
List<String>	listTables(String databaseName) Get names of all tables under this database.
PagedList<String>	listTablesPaged(String databaseName, Integer maxResults, String pageToken, String tableNamePattern) Get paged list names of tables under this database.
PagedList<String>	listTablesPagedGlobally(String databaseNamePattern, String tableNamePattern, Integer maxResults, String pageToken) Gets an array of tables for a catalog.
PagedList<View>	listViewDetailsPaged(String db, Integer maxResults, String pageToken, String viewNamePattern) Get paged list view details under this database.
List<String>	listViews(String databaseName) Get names of all views under this database.
PagedList<String>	listViewsPaged(String databaseName, Integer maxResults, String pageToken, String viewNamePattern) Get paged list names of views under this database.
PagedList<String>	listViewsPagedGlobally(String databaseNamePattern, String viewNamePattern, Integer maxResults, String pageToken) Gets an array of views for a catalog.
Optional<TableSnapshot>	loadSnapshot(Identifier identifier) Return the snapshot of table identified by the given Identifier.
Optional<Snapshot>	loadSnapshot(Identifier identifier, String version) Return the snapshot of table for given version.
protected GetTableTokenResponse	loadTableToken(Identifier identifier)
void	markDonePartitions(Identifier identifier, List<Map<String,String>> partitions) Mark partitions done of the specify table.
Map<String,String>	options() Catalog options for re-creating this catalog.
void	renameTable(Identifier fromTable, Identifier toTable, boolean ignoreIfNotExists) Rename a table.
void	renameView(Identifier fromView, Identifier toView, boolean ignoreIfNotExists) Rename a view.
void	rollbackTo(Identifier identifier, Instant instant) rollback table by the given Identifier and instant.
boolean	supportsListByPattern() Whether this catalog supports name pattern filter when list objects paged.
boolean	supportsListObjectsPaged() Whether this catalog supports list objects paged.
boolean	supportsVersionManagement() Whether this catalog supports version management for tables.

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, invalidateTable, repairCatalog, repairDatabase, repairTable

Constructor Detail

RESTCatalog

public RESTCatalog(CatalogContext context)

RESTCatalog

public RESTCatalog(CatalogContext context,
                   boolean configRequired)

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

catalogLoader

public RESTCatalogLoader catalogLoader()

Description copied from interface: Catalog

Serializable loader to create catalog.

Specified by:

catalogLoader in interface Catalog

listDatabases

public List<String> listDatabases()

Description copied from interface: Catalog

Get the names of all databases in this catalog.

Specified by:

listDatabases in interface Catalog

Returns:

a list of the names of all databases

listDatabasesPaged

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

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.

databaseNamePattern - A sql LIKE pattern (%) for database names. All databases will be returned * if not set or empty. Currently, only prefix matching is supported.

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

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

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

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,
                                         @Nullable
                                         Integer maxResults,
                                         @Nullable
                                         String pageToken,
                                         @Nullable
                                         String tableNamePattern)
                                  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.

tableNamePattern - A sql LIKE pattern (%) for table names. All tables will be returned if not set or empty. Currently, only prefix matching is supported.

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 db,
                                              @Nullable
                                              Integer maxResults,
                                              @Nullable
                                              String pageToken,
                                              @Nullable
                                              String tableNamePattern)
                                       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:

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

tableNamePattern - A sql LIKE pattern (%) for table names. All table details will be returned if not set or empty. Currently, only prefix matching is supported.

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

listTablesPagedGlobally

public PagedList<String> listTablesPagedGlobally(@Nullable
                                                 String databaseNamePattern,
                                                 @Nullable
                                                 String tableNamePattern,
                                                 @Nullable
                                                 Integer maxResults,
                                                 @Nullable
                                                 String pageToken)

Description copied from interface: Catalog

Gets an array of tables for a catalog.

NOTE: System tables will not be listed.

Specified by:

listTablesPagedGlobally in interface Catalog

Parameters:

databaseNamePattern - A sql LIKE pattern (%) for database names. All databases will be returned if not set or empty. Currently, only prefix matching is supported.

tableNamePattern - A sql LIKE pattern (%) for table names. All tables will be returned if not set or empty. Currently, only prefix matching is supported.

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 tables with provided page size under this databaseNamePattern & tableNamePattern and next page token

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

loadSnapshot

public Optional<TableSnapshot> loadSnapshot(Identifier identifier)
                                     throws Catalog.TableNotExistException

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

Throws:

Catalog.TableNotExistException - if the target does not exist

loadSnapshot

public Optional<Snapshot> loadSnapshot(Identifier identifier,
                                       String version)
                                throws Catalog.TableNotExistException

Description copied from interface: Catalog

Return the snapshot of table for given version. Version parsing order is:

• 1. If it is 'EARLIEST', get the earliest snapshot.
• 2. If it is 'LATEST', get the latest snapshot.
• 3. If it is a number, get snapshot by snapshot id.
• 4. Else try to get snapshot from Tag name.

Specified by:

loadSnapshot in interface Catalog

Parameters:

identifier - Path of the table

version - version to snapshot

Returns:

The requested snapshot

Throws:

Catalog.TableNotExistException - if the target does not exist

listSnapshotsPaged

public PagedList<Snapshot> listSnapshotsPaged(Identifier identifier,
                                              @Nullable
                                              Integer maxResults,
                                              @Nullable
                                              String pageToken)
                                       throws Catalog.TableNotExistException

Description copied from interface: Catalog

Get paged snapshot list of the table, the snapshot list will be returned in descending order.

Specified by:

listSnapshotsPaged 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 snapshots with provided page size(@param maxResults) in this table and next page token, or a list of all snapshots of the table if the catalog does not Catalog.supportsListObjectsPaged().

Throws:

Catalog.TableNotExistException - if the table does not exist

supportsListObjectsPaged

public boolean supportsListObjectsPaged()

Description copied from interface: Catalog

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

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

Specified by:

supportsListObjectsPaged in interface Catalog

supportsListByPattern

public boolean supportsListByPattern()

Description copied from interface: Catalog

Whether this catalog supports name pattern filter when list objects paged. If not, corresponding methods will throw exception if name pattern provided.

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

Specified by:

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

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

commitSnapshot

public boolean commitSnapshot(Identifier identifier,
                              @Nullable
                              String tableUuid,
                              Snapshot snapshot,
                              List<PartitionStatistics> statistics)
                       throws Catalog.TableNotExistException

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

tableUuid - Uuid of the table to avoid wrong commit

snapshot - Snapshot to be committed

statistics - statistics information of this change

Returns:

Success or not

Throws:

Catalog.TableNotExistException - if the target does not exist

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

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

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

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

authTableQuery

public List<String> authTableQuery(Identifier identifier,
                                   @Nullable
                                   List<String> select)
                            throws Catalog.TableNotExistException

Description copied from interface: Catalog

Auth table query select and get the filter for row level access control.

Specified by:

authTableQuery in interface Catalog

Parameters:

identifier - path of the table to alter partitions

select - selected fields, null if select all

Returns:

additional filter for row level access control

Throws:

Catalog.TableNotExistException - if the table does not exist

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

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,
                                                @Nullable
                                                Integer maxResults,
                                                @Nullable
                                                String pageToken,
                                                @Nullable
                                                String partitionNamePattern)
                                         throws Catalog.TableNotExistException

Description copied from interface: Catalog

Get paged partition list of the table, the partition list will be returned in descending order.

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.

partitionNamePattern - A sql LIKE pattern (%) for partition names. All partitions will be returned if not set or empty. Currently, only prefix matching is supported.

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

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

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

listFunctions

public List<String> listFunctions(String databaseName)
                           throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Get the names of all functions in this catalog.

Specified by:

listFunctions in interface Catalog

Returns:

a list of the names of all functions

Throws:

Catalog.DatabaseNotExistException - if the database does not exist

getFunction

public Function getFunction(Identifier identifier)
                     throws Catalog.FunctionNotExistException

Description copied from interface: Catalog

Get function by name.

Specified by:

getFunction in interface Catalog

Parameters:

identifier - Path of the function to get

Returns:

The requested function

Throws:

Catalog.FunctionNotExistException - if the function does not exist

createFunction

public void createFunction(Identifier identifier,
                           Function function,
                           boolean ignoreIfExists)
                    throws Catalog.FunctionAlreadyExistException,
                           Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Create a new function.

NOTE: System functions can not be created.

Specified by:

createFunction in interface Catalog

Parameters:

identifier - path of the function to be created

function - the function definition

ignoreIfExists - flag to specify behavior when a function already exists at the given path: if set to false, it throws a FunctionAlreadyExistException, if set to true, do nothing.

Throws:

Catalog.FunctionAlreadyExistException - if function already exists and ignoreIfExists is false

Catalog.DatabaseNotExistException - if the database in identifier doesn't exist

dropFunction

public void dropFunction(Identifier identifier,
                         boolean ignoreIfNotExists)
                  throws Catalog.FunctionNotExistException

Description copied from interface: Catalog

Drop function.

Specified by:

dropFunction in interface Catalog

Parameters:

identifier - path of the function to be created

ignoreIfNotExists - Flag to specify behavior when the function does not exist

Throws:

Catalog.FunctionNotExistException - if the function doesn't exist

alterFunction

public void alterFunction(Identifier identifier,
                          List<FunctionChange> changes,
                          boolean ignoreIfNotExists)
                   throws Catalog.FunctionNotExistException,
                          Catalog.DefinitionAlreadyExistException,
                          Catalog.DefinitionNotExistException

Description copied from interface: Catalog

Alter function.

Specified by:

alterFunction in interface Catalog

Parameters:

identifier - path of the function to be created

changes - the function changes

ignoreIfNotExists - Flag to specify behavior when the function does not exist

Throws:

Catalog.FunctionNotExistException - if the function doesn't exist

Catalog.DefinitionAlreadyExistException

Catalog.DefinitionNotExistException

getView

public View getView(Identifier identifier)
             throws Catalog.ViewNotExistException

Description copied from interface: Catalog

Return a View identified by the given Identifier.

Specified by:

getView in interface Catalog

Parameters:

identifier - Path of the view

Returns:

The requested view

Throws:

Catalog.ViewNotExistException - if the target does not exist

dropView

public void dropView(Identifier identifier,
                     boolean ignoreIfNotExists)
              throws Catalog.ViewNotExistException

Description copied from interface: Catalog

Drop a view.

Specified by:

dropView in interface Catalog

Parameters:

identifier - Path of the view to be dropped

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

Throws:

Catalog.ViewNotExistException - if the view does not exist

createView

public void createView(Identifier identifier,
                       View view,
                       boolean ignoreIfExists)
                throws Catalog.ViewAlreadyExistException,
                       Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Create a new view.

Specified by:

createView in interface Catalog

Parameters:

identifier - path of the view to be created

view - the view definition

ignoreIfExists - flag to specify behavior when a view already exists at the given path: if set to false, it throws a ViewAlreadyExistException, if set to true, do nothing.

Throws:

Catalog.ViewAlreadyExistException - if view already exists and ignoreIfExists is false

Catalog.DatabaseNotExistException - if the database in identifier doesn't exist

listViews

public List<String> listViews(String databaseName)
                       throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

Get names of all views under this database. An empty list is returned if none exists.

Specified by:

listViews in interface Catalog

Returns:

a list of the names of all views in this database

Throws:

Catalog.DatabaseNotExistException - if the database does not exist

listViewsPaged

public PagedList<String> listViewsPaged(String databaseName,
                                        @Nullable
                                        Integer maxResults,
                                        @Nullable
                                        String pageToken,
                                        @Nullable
                                        String viewNamePattern)
                                 throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

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

Specified by:

listViewsPaged in interface Catalog

Parameters:

databaseName - Name of the database to list views.

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.

viewNamePattern - A sql LIKE pattern (%) for view names. All views will be returned if not set or empty. Currently, only prefix matching is supported.

Returns:

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

Throws:

Catalog.DatabaseNotExistException - if the database does not exist

listViewDetailsPaged

public PagedList<View> listViewDetailsPaged(String db,
                                            @Nullable
                                            Integer maxResults,
                                            @Nullable
                                            String pageToken,
                                            @Nullable
                                            String viewNamePattern)
                                     throws Catalog.DatabaseNotExistException

Description copied from interface: Catalog

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

Specified by:

listViewDetailsPaged in interface Catalog

Parameters:

db - Name of the database to list views.

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.

viewNamePattern - A sql LIKE pattern (%) for view names. All view details will be returned if not set or empty. Currently, only prefix matching is supported.

Returns:

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

Throws:

Catalog.DatabaseNotExistException - if the database does not exist

listViewsPagedGlobally

public PagedList<String> listViewsPagedGlobally(@Nullable
                                                String databaseNamePattern,
                                                @Nullable
                                                String viewNamePattern,
                                                @Nullable
                                                Integer maxResults,
                                                @Nullable
                                                String pageToken)

Description copied from interface: Catalog

Gets an array of views for a catalog.

NOTE: System tables will not be listed.

Specified by:

listViewsPagedGlobally in interface Catalog

Parameters:

databaseNamePattern - A sql LIKE pattern (%) for database names. All databases will be returned if not set or empty. Currently, only prefix matching is supported.

viewNamePattern - A sql LIKE pattern (%) for view names. All views will be returned if not set or empty. Currently, only prefix matching is supported.

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 views with provided page size under this databaseNamePattern & tableNamePattern and next page token

renameView

public void renameView(Identifier fromView,
                       Identifier toView,
                       boolean ignoreIfNotExists)
                throws Catalog.ViewNotExistException,
                       Catalog.ViewAlreadyExistException

Description copied from interface: Catalog

Rename a view.

Specified by:

renameView in interface Catalog

Parameters:

fromView - identifier of the view to rename

toView - new view identifier

Throws:

Catalog.ViewNotExistException - if the fromView does not exist

Catalog.ViewAlreadyExistException - if the toView already exists

alterView

public void alterView(Identifier identifier,
                      List<ViewChange> viewChanges,
                      boolean ignoreIfNotExists)
               throws Catalog.ViewNotExistException,
                      Catalog.DialectAlreadyExistException,
                      Catalog.DialectNotExistException

Description copied from interface: Catalog

Alter a view.

Specified by:

alterView in interface Catalog

Parameters:

identifier - identifier of the view to alter

viewChanges - - changes of view

ignoreIfNotExists - Flag to specify behavior when the view does not exist

Throws:

Catalog.ViewNotExistException - if the view does not exist

Catalog.DialectAlreadyExistException - if the dialect already exists

Catalog.DialectNotExistException - if the dialect not exists

caseSensitive

public boolean caseSensitive()

Description copied from interface: Catalog

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

Specified by:

caseSensitive in interface Catalog

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

loadTableToken

protected GetTableTokenResponse loadTableToken(Identifier identifier)
                                        throws Catalog.TableNotExistException

Throws:

Catalog.TableNotExistException