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.ColumnAlreadyExistException, Catalog.ColumnNotExistException, Catalog.DatabaseAlreadyExistException, Catalog.DatabaseNoPermissionException, Catalog.DatabaseNotEmptyException, Catalog.DatabaseNotExistException, Catalog.PartitionNotExistException, 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

Constructor Summary

Constructors

Constructor and Description
RESTCatalog(CatalogContext context)

Method Summary

Modifier and Type	Method and Description
void	alterDatabase(String name, List<PropertyChange> changes, boolean ignoreIfNotExists) Alter a database.
void	alterTable(Identifier identifier, List<SchemaChange> changes, boolean ignoreIfNotExists) Modify an existing table from SchemaChanges.
boolean	caseSensitive() Return a boolean that indicates whether this catalog is case-sensitive.
void	close()
void	createDatabase(String name, boolean ignoreIfExists, Map<String,String> properties) Create a database with properties.
void	createPartition(Identifier identifier, Map<String,String> partitionSpec) Create the partition of the specify table.
void	createTable(Identifier identifier, Schema schema, boolean ignoreIfExists) Create a new table.
void	dropDatabase(String name, boolean ignoreIfNotExists, boolean cascade) Drop a database.
void	dropPartition(Identifier identifier, Map<String,String> partition) Drop the partition of the specify table.
void	dropTable(Identifier identifier, boolean ignoreIfNotExists) Drop a table.
FileIO	fileIO() FileIO of this catalog.
Database	getDatabase(String name) Return a Database identified by the given name.
Table	getTable(Identifier identifier) Return a Table identified by the given Identifier.
List<String>	listDatabases() Get the names of all databases in this catalog.
List<Partition>	listPartitions(Identifier identifier) Get Partition of all partitions of the table.
List<String>	listTables(String databaseName) Get names of all tables under this database.
Map<String,String>	options() Catalog options for re-creating this catalog.
void	renameTable(Identifier fromTable, Identifier toTable, boolean ignoreIfNotExists) Rename a table.
String	warehouse() Warehouse root path for creating new databases.

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, createView, dropView, getView, invalidateTable, listViews, renameView, repairCatalog, repairDatabase, repairTable

Constructor Detail

RESTCatalog

public RESTCatalog(CatalogContext context)

Method Detail

warehouse

public String warehouse()

Description copied from interface: Catalog

Warehouse root path for creating new databases.

Specified by:

warehouse in interface Catalog

options

public Map<String,String> options()

Description copied from interface: Catalog

Catalog options for re-creating this catalog.

Specified by:

options in interface Catalog

fileIO

public FileIO fileIO()

Description copied from interface: Catalog

FileIO of this catalog. It can access Catalog.warehouse() path.

Specified by:

fileIO 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

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

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

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

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

createPartition

public void createPartition(Identifier identifier,
                            Map<String,String> partitionSpec)
                     throws Catalog.TableNotExistException

Description copied from interface: Catalog

Create the partition of the specify table.

Only catalog with metastore can support this method, and only table with 'metastore.partitioned-table' can support this method.

Specified by:

createPartition in interface Catalog

Parameters:

identifier - path of the table to drop partition

partitionSpec - the partition to be created

Throws:

Catalog.TableNotExistException - if the table does not exist

dropPartition

public void dropPartition(Identifier identifier,
                          Map<String,String> partition)
                   throws Catalog.TableNotExistException,
                          Catalog.PartitionNotExistException

Description copied from interface: Catalog

Drop the partition of the specify table.

Specified by:

dropPartition in interface Catalog

Parameters:

identifier - path of the table to drop partition

partition - the partition to be deleted

Throws:

Catalog.TableNotExistException - if the table does not exist

Catalog.PartitionNotExistException - if the partition 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

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