org.apache.gravitino

Interface SupportsCatalogs

All Known Implementing Classes:

GravitinoClient, GravitinoMetalake

@Evolving
public interface SupportsCatalogs

Client interface for supporting catalogs. It includes methods for listing, loading, creating, altering and dropping catalogs.

Method Summary

Modifier and Type	Method and Description
Catalog	alterCatalog(java.lang.String catalogName, CatalogChange... changes) Alter a catalog with specified identifier.
default boolean	catalogExists(java.lang.String catalogName) Check if a catalog exists.
Catalog	createCatalog(java.lang.String catalogName, Catalog.Type type, java.lang.String provider, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Create a catalog with specified identifier.
boolean	dropCatalog(java.lang.String catalogName) Drop a catalog with specified identifier.
java.lang.String[]	listCatalogs() List the name of all catalogs in the metalake.
Catalog[]	listCatalogsInfo() List all catalogs with their information in the metalake.
Catalog	loadCatalog(java.lang.String catalogName) Load a catalog by its identifier.
void	testConnection(java.lang.String catalogName, Catalog.Type type, java.lang.String provider, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Test whether the catalog with specified parameters can be connected to before creating it.

Method Detail

listCatalogs

java.lang.String[] listCatalogs()
                         throws NoSuchMetalakeException

List the name of all catalogs in the metalake.

Returns:

The list of catalog's names.

Throws:

NoSuchMetalakeException - If the metalake does not exist.

listCatalogsInfo

Catalog[] listCatalogsInfo()
                    throws NoSuchMetalakeException

List all catalogs with their information in the metalake.

Returns:

The list of catalog's information.

Throws:

NoSuchMetalakeException - If the metalake with namespace does not exist.

loadCatalog

Catalog loadCatalog(java.lang.String catalogName)
             throws NoSuchCatalogException

Load a catalog by its identifier.

Parameters:

catalogName - the identifier of the catalog.

Returns:

The catalog.

Throws:

NoSuchCatalogException - If the catalog does not exist.

catalogExists

default boolean catalogExists(java.lang.String catalogName)

Check if a catalog exists.

Parameters:

catalogName - The identifier of the catalog.

Returns:

True if the catalog exists, false otherwise.

createCatalog

Catalog createCatalog(java.lang.String catalogName,
                      Catalog.Type type,
                      java.lang.String provider,
                      java.lang.String comment,
                      java.util.Map<java.lang.String,java.lang.String> properties)
               throws NoSuchMetalakeException,
                      CatalogAlreadyExistsException

Create a catalog with specified identifier.

The parameter "provider" is a short name of the catalog, used to tell Gravitino which catalog should be created. The short name should be the same as the CatalogProvider interface provided.

Parameters:

catalogName - the name of the catalog.

type - the type of the catalog.

provider - the provider of the catalog.

comment - the comment of the catalog.

properties - the properties of the catalog.

Returns:

The created catalog.

Throws:

NoSuchMetalakeException - If the metalake does not exist.

CatalogAlreadyExistsException - If the catalog already exists.

alterCatalog

Catalog alterCatalog(java.lang.String catalogName,
                     CatalogChange... changes)
              throws NoSuchCatalogException,
                     java.lang.IllegalArgumentException

Alter a catalog with specified identifier.

Parameters:

catalogName - the identifier of the catalog.

changes - the changes to apply to the catalog.

Returns:

The altered catalog.

Throws:

NoSuchCatalogException - If the catalog does not exist.

java.lang.IllegalArgumentException - If the changes cannot be applied to the catalog.

dropCatalog

boolean dropCatalog(java.lang.String catalogName)

Drop a catalog with specified identifier.

Parameters:

catalogName - the name of the catalog.

Returns:

True if the catalog was dropped, false otherwise.

testConnection

void testConnection(java.lang.String catalogName,
                    Catalog.Type type,
                    java.lang.String provider,
                    java.lang.String comment,
                    java.util.Map<java.lang.String,java.lang.String> properties)
             throws java.lang.Exception

Test whether the catalog with specified parameters can be connected to before creating it.

Parameters:

catalogName - the name of the catalog.

type - the type of the catalog.

provider - the provider of the catalog.

comment - the comment of the catalog.

properties - the properties of the catalog.

Throws:

java.lang.Exception - if the test failed.