com.starrocks.connector.flink.catalog

Class StarRocksCatalog

java.lang.Object

com.starrocks.connector.flink.catalog.StarRocksCatalog

All Implemented Interfaces:

Serializable

public class StarRocksCatalog
extends Object
implements Serializable

Responsible for reading and writing metadata such as database/table from StarRocks.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StarRocksCatalog(String jdbcUrl, String username, String password)

Method Summary

Modifier and Type	Method and Description
void	alterAddColumns(String databaseName, String tableName, List<StarRocksColumn> addColumns, long timeoutSecond) Add columns to a table.
void	alterDropColumns(String databaseName, String tableName, List<String> dropColumns, long timeoutSecond) Drop columns of a table.
void	close() Close the catalog when it is no longer needed and release any resource that it might be holding.
void	createDatabase(String databaseName, boolean ignoreIfExists) Create a database.
void	createTable(StarRocksTable table, boolean ignoreIfExists) Creates a table.
boolean	databaseExists(String databaseName) Check if a database exists in this catalog.
Optional<StarRocksTable>	getTable(String databaseName, String tableName) Returns a StarRocksTable identified by the given databaseName and tableName.
void	open() Open the catalog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StarRocksCatalog

public StarRocksCatalog(String jdbcUrl,
                        String username,
                        String password)

Method Detail

open

public void open()
          throws StarRocksCatalogException

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

Throws:

StarRocksCatalogException - in case of any runtime exception

close

public void close()
           throws StarRocksCatalogException

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

Throws:

StarRocksCatalogException - in case of any runtime exception

databaseExists

public boolean databaseExists(String databaseName)
                       throws StarRocksCatalogException

Check if a database exists in this catalog.

Parameters:

databaseName - Name of the database

Returns:

true if the given database exists in the catalog false otherwise

Throws:

StarRocksCatalogException - in case of any runtime exception

createDatabase

public void createDatabase(String databaseName,
                           boolean ignoreIfExists)
                    throws StarRocksCatalogException

Create a database.

Parameters:

databaseName - Name of the database

ignoreIfExists - Flag to specify behavior when a database with the given name already exists: if set to false, throw a StarRocksCatalogException, if set to true, do nothing.

Throws:

StarRocksCatalogException - in case of any runtime exception

getTable

public Optional<StarRocksTable> getTable(String databaseName,
                                         String tableName)
                                  throws StarRocksCatalogException

Returns a StarRocksTable identified by the given databaseName and tableName.

Parameters:

databaseName - Name of the database

tableName - Name of the table

Returns:

an optional of the requested table. null if the table does not exist.

Throws:

StarRocksCatalogException - in case of any runtime exception

createTable

public void createTable(StarRocksTable table,
                        boolean ignoreIfExists)
                 throws StarRocksCatalogException

Creates a table.

Parameters:

table - the table definition

ignoreIfExists - flag to specify behavior when a table already exists. if set to false, it throws a TableAlreadyExistException, if set to true, do nothing.

Throws:

StarRocksCatalogException - in case of any runtime exception

alterAddColumns

public void alterAddColumns(String databaseName,
                            String tableName,
                            List<StarRocksColumn> addColumns,
                            long timeoutSecond)
                     throws StarRocksCatalogException

Add columns to a table. Note that those columns will be added to the last position.

Parameters:

databaseName - Name of the database

tableName - Name of the table

addColumns - Columns to add

timeoutSecond - Timeout for a schema change on StarRocks side

Throws:

StarRocksCatalogException - in case of any runtime exception

alterDropColumns

public void alterDropColumns(String databaseName,
                             String tableName,
                             List<String> dropColumns,
                             long timeoutSecond)
                      throws StarRocksCatalogException

Drop columns of a table.

Parameters:

databaseName - Name of the database

tableName - Name of the table

dropColumns - Columns to drop

timeoutSecond - Timeout for a schema change on StarRocks side

Throws:

StarRocksCatalogException - in case of any runtime exception