com.datastrato.gravitino.client

Class GravitinoMetalake

java.lang.Object

com.datastrato.gravitino.dto.MetalakeDTO

com.datastrato.gravitino.client.GravitinoMetalake

All Implemented Interfaces:

Auditable, Metalake, SupportsCatalogs

public class GravitinoMetalake
extends MetalakeDTO
implements SupportsCatalogs

Gravitino Metalake is the top-level metadata repository for users. It contains a list of catalogs as sub-level metadata collections. With GravitinoMetalake, users can list, create, load, alter and drop a catalog with specified identifier.

Method Summary

Modifier and Type	Method and Description
Catalog	alterCatalog(NameIdentifier ident, CatalogChange... changes) Alter the catalog with specified identifier by applying the changes.
static com.datastrato.gravitino.client.GravitinoMetalake.Builder	builder()
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 new catalog with specified identifier, type, comment and properties.
boolean	dropCatalog(NameIdentifier ident) Drop the catalog with specified identifier.
NameIdentifier[]	listCatalogs(Namespace namespace) List all the catalogs under this metalake with specified namespace.
Catalog[]	listCatalogsInfo(Namespace namespace) List all the catalogs with their information under this metalake with specified namespace.
Catalog	loadCatalog(NameIdentifier ident) Load the catalog with specified identifier.

Methods inherited from class com.datastrato.gravitino.dto.MetalakeDTO

auditInfo, comment, equals, hashCode, name, properties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datastrato.gravitino.SupportsCatalogs

catalogExists

Method Detail

listCatalogs

public NameIdentifier[] listCatalogs(Namespace namespace)
                              throws NoSuchMetalakeException

List all the catalogs under this metalake with specified namespace.

Specified by:

listCatalogs in interface SupportsCatalogs

Parameters:

namespace - The namespace to list the catalogs under it.

Returns:

A list of NameIdentifier of the catalogs under the specified namespace.

Throws:

NoSuchMetalakeException - if the metalake with specified namespace does not exist.

listCatalogsInfo

public Catalog[] listCatalogsInfo(Namespace namespace)
                           throws NoSuchMetalakeException

List all the catalogs with their information under this metalake with specified namespace.

Specified by:

listCatalogsInfo in interface SupportsCatalogs

Parameters:

namespace - The namespace to list the catalogs under it.

Returns:

A list of Catalog under the specified namespace.

Throws:

NoSuchMetalakeException - if the metalake with specified namespace does not exist.

loadCatalog

public Catalog loadCatalog(NameIdentifier ident)
                    throws NoSuchCatalogException

Load the catalog with specified identifier.

Specified by:

loadCatalog in interface SupportsCatalogs

Parameters:

ident - The identifier of the catalog to load.

Returns:

The Catalog with specified identifier.

Throws:

NoSuchCatalogException - if the catalog with specified identifier does not exist.

createCatalog

public 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 new catalog with specified identifier, type, comment and properties.

Specified by:

createCatalog in interface SupportsCatalogs

Parameters:

ident - The identifier 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 with specified namespace does not exist.

CatalogAlreadyExistsException - if the catalog with specified identifier already exists.

alterCatalog

public Catalog alterCatalog(NameIdentifier ident,
                            CatalogChange... changes)
                     throws NoSuchCatalogException,
                            java.lang.IllegalArgumentException

Alter the catalog with specified identifier by applying the changes.

Specified by:

alterCatalog in interface SupportsCatalogs

Parameters:

ident - the identifier of the catalog.

changes - the changes to apply to the catalog.

Returns:

the altered Catalog.

Throws:

NoSuchCatalogException - if the catalog with specified identifier does not exist.

java.lang.IllegalArgumentException - if the changes are invalid.

dropCatalog

public boolean dropCatalog(NameIdentifier ident)

Drop the catalog with specified identifier.

Specified by:

dropCatalog in interface SupportsCatalogs

Parameters:

ident - the identifier of the catalog.

Returns:

true if the catalog is dropped successfully, false otherwise.

builder

public static com.datastrato.gravitino.client.GravitinoMetalake.Builder builder()

Returns:

the builder for creating a new instance of GravitinoMetaLake.