com.datastrato.gravitino

Interface SupportsCatalogs

All Known Implementing Classes:

GravitinoClient, GravitinoMetalake

@Evolving
public interface SupportsCatalogs

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(NameIdentifier ident, CatalogChange... changes) Alter a catalog with specified identifier.
default boolean	catalogExists(NameIdentifier ident) Check if a catalog exists.
Catalog	createCatalog(NameIdentifier ident, 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(NameIdentifier ident) Drop a catalog with specified identifier.
NameIdentifier[]	listCatalogs(Namespace namespace) List all catalogs in the metalake under the namespace Namespace.
Catalog[]	listCatalogsInfo(Namespace namespace) List all catalogs with their information in the metalake under the namespace Namespace.
Catalog	loadCatalog(NameIdentifier ident) Load a catalog by its identifier.

Method Detail

listCatalogs

NameIdentifier[] listCatalogs(Namespace namespace)
                       throws NoSuchMetalakeException

List all catalogs in the metalake under the namespace Namespace.

Parameters:

namespace - The namespace to list the catalogs under it.

Returns:

The list of catalog's name identifiers.

Throws:

NoSuchMetalakeException - If the metalake with namespace does not exist.

listCatalogsInfo

Catalog[] listCatalogsInfo(Namespace namespace)
                    throws NoSuchMetalakeException

List all catalogs with their information in the metalake under the namespace Namespace.

Parameters:

namespace - The namespace to list the catalogs under it.

Returns:

The list of catalog's information.

Throws:

NoSuchMetalakeException - If the metalake with namespace does not exist.

loadCatalog

Catalog loadCatalog(NameIdentifier ident)
             throws NoSuchCatalogException

Load a catalog by its identifier.

Parameters:

ident - the identifier of the catalog.

Returns:

The catalog.

Throws:

NoSuchCatalogException - If the catalog does not exist.

catalogExists

default boolean catalogExists(NameIdentifier ident)

Check if a catalog exists.

Parameters:

ident - The identifier of the catalog.

Returns:

True if the catalog exists, false otherwise.

createCatalog

Catalog createCatalog(NameIdentifier ident,
                      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:

ident - the identifier of the catalog.

type - the type of the catalog.

comment - the comment of the catalog.

provider - the provider 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(NameIdentifier ident,
                     CatalogChange... changes)
              throws NoSuchCatalogException,
                     java.lang.IllegalArgumentException

Alter a catalog with specified identifier.

Parameters:

ident - 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(NameIdentifier ident)

Drop a catalog with specified identifier.

Parameters:

ident - the identifier of the catalog.

Returns:

True if the catalog was dropped, false otherwise.