org.apache.seatunnel.api.table.catalog

接口 Catalog

所有超级接口:

AutoCloseable

public interface Catalog
extends AutoCloseable

Interface for reading and writing table metadata from SeaTunnel. Each connector need to contain the implementation of Catalog.

方法概要

限定符和类型	方法和说明
default List<CatalogTable>	buildCatalogTablesWithErrorCheck(Iterator<TablePath> tablePaths)
default <T> void	buildColumnsWithErrorCheck(TablePath tablePath, TableSchema.Builder builder, Iterator<T> keys, java.util.function.Function<T,Column> getColumn)
void	close() Close the catalog when it is no longer needed and release any resource that it might be holding.
void	createDatabase(TablePath tablePath, boolean ignoreIfExists)
void	createTable(TablePath tablePath, CatalogTable table, boolean ignoreIfExists) Create a new table in this catalog.
boolean	databaseExists(String databaseName) Check if a database exists in this catalog.
void	dropDatabase(TablePath tablePath, boolean ignoreIfNotExists)
void	dropTable(TablePath tablePath, boolean ignoreIfNotExists) Drop an existing table in this catalog.
default void	executeSql(TablePath tablePath, String sql)
String	getDefaultDatabase() Get the name of the default database for this catalog.
default Optional<Factory>	getFactory()
CatalogTable	getTable(TablePath tablePath) Return a CatalogTable identified by the given TablePath.
default List<CatalogTable>	getTables(ReadonlyConfig config)
default boolean	isExistsData(TablePath tablePath)
List<String>	listDatabases() Get the names of all databases in this catalog.
List<String>	listTables(String databaseName) Get names of all tables under this database.
String	name() Get the name of the catalog.
void	open() Open the catalog.
boolean	tableExists(TablePath tablePath) Check if a table exist in this catalog.
default void	truncateTable(TablePath tablePath, boolean ignoreIfNotExists) Truncate an existing table data in this catalog.

方法详细资料

getFactory

default Optional<Factory> getFactory()

open

void open()
   throws CatalogException

Open the catalog. Used for any required preparation in initialization phase.

抛出:

CatalogException - in case of any runtime exception

close

void close()
    throws CatalogException

Close the catalog when it is no longer needed and release any resource that it might be holding.

指定者:

close 在接口中 AutoCloseable

抛出:

CatalogException - in case of any runtime exception

name

String name()

Get the name of the catalog.

getDefaultDatabase

String getDefaultDatabase()
                   throws CatalogException

Get the name of the default database for this catalog. The default database will be the current database for the catalog when user's session doesn't specify a current database. The value probably comes from configuration, will not change for the life time of the catalog instance.

返回:

the name of the current database

抛出:

CatalogException - in case of any runtime exception

databaseExists

boolean databaseExists(String databaseName)
                throws CatalogException

Check if a database exists in this catalog.

参数:

databaseName - Name of the database

返回:

true if the given database exists in the catalog false otherwise

抛出:

CatalogException - in case of any runtime exception

listDatabases

List<String> listDatabases()
                    throws CatalogException

Get the names of all databases in this catalog.

返回:

a list of the names of all databases

抛出:

CatalogException - in case of any runtime exception

listTables

List<String> listTables(String databaseName)
                 throws CatalogException,
                        DatabaseNotExistException

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

返回:

a list of the names of all tables in this database

抛出:

CatalogException - in case of any runtime exception

DatabaseNotExistException

tableExists

boolean tableExists(TablePath tablePath)
             throws CatalogException

Check if a table exist in this catalog.

参数:

tablePath - Path of the table

返回:

true if the given table exists in the catalog false otherwise

抛出:

CatalogException - in case of any runtime exception

getTable

CatalogTable getTable(TablePath tablePath)
               throws CatalogException,
                      TableNotExistException

Return a CatalogTable identified by the given TablePath. The framework will resolve the metadata objects when necessary.

参数:

tablePath - Path of the table

返回:

The requested table

抛出:

CatalogException - in case of any runtime exception

TableNotExistException

getTables

default List<CatalogTable> getTables(ReadonlyConfig config)
                              throws CatalogException

抛出:

CatalogException

buildCatalogTablesWithErrorCheck

default List<CatalogTable> buildCatalogTablesWithErrorCheck(Iterator<TablePath> tablePaths)

buildColumnsWithErrorCheck

default <T> void buildColumnsWithErrorCheck(TablePath tablePath,
                                            TableSchema.Builder builder,
                                            Iterator<T> keys,
                                            java.util.function.Function<T,Column> getColumn)

createTable

void createTable(TablePath tablePath,
                 CatalogTable table,
                 boolean ignoreIfExists)
          throws TableAlreadyExistException,
                 DatabaseNotExistException,
                 CatalogException

Create a new table in this catalog.

参数:

tablePath - Path of the table

table - The table definition

ignoreIfExists - Flag to specify behavior when a table with the given name already exist

抛出:

TableAlreadyExistException - thrown if the table already exists in the catalog and ignoreIfExists is false

DatabaseNotExistException - thrown if the database in tablePath doesn't exist in the catalog

CatalogException - in case of any runtime exception

dropTable

void dropTable(TablePath tablePath,
               boolean ignoreIfNotExists)
        throws TableNotExistException,
               CatalogException

Drop an existing table in this catalog.

参数:

tablePath - Path of the table

ignoreIfNotExists - Flag to specify behavior when a table with the given name doesn't exist

抛出:

TableNotExistException - thrown if the table doesn't exist in the catalog and ignoreIfNotExists is false

CatalogException - in case of any runtime exception

createDatabase

void createDatabase(TablePath tablePath,
                    boolean ignoreIfExists)
             throws DatabaseAlreadyExistException,
                    CatalogException

抛出:

DatabaseAlreadyExistException

CatalogException

dropDatabase

void dropDatabase(TablePath tablePath,
                  boolean ignoreIfNotExists)
           throws DatabaseNotExistException,
                  CatalogException

抛出:

DatabaseNotExistException

CatalogException

truncateTable

default void truncateTable(TablePath tablePath,
                           boolean ignoreIfNotExists)
                    throws TableNotExistException,
                           CatalogException

Truncate an existing table data in this catalog.

参数:

tablePath - Path of the table

ignoreIfNotExists - Flag to specify behavior when a table with the given name doesn't exist

抛出:

TableNotExistException - thrown if the table doesn't exist in the catalog and ignoreIfNotExists is false

CatalogException - in case of any runtime exception

isExistsData

default boolean isExistsData(TablePath tablePath)

executeSql

default void executeSql(TablePath tablePath,
                        String sql)