com.datastrato.gravitino.client

Class GravitinoClient

java.lang.Object

com.datastrato.gravitino.client.GravitinoClientBase

com.datastrato.gravitino.client.GravitinoClient

All Implemented Interfaces:

SupportsCatalogs, java.io.Closeable, java.lang.AutoCloseable

public class GravitinoClient
extends GravitinoClientBase
implements SupportsCatalogs

Gravitino Client for an user to interact with the Gravitino API, allowing the client to list, load, create, and alter Catalog.

It uses an underlying RESTClient to send HTTP requests and receive responses from the API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GravitinoClient.ClientBuilder Builder class for constructing a GravitinoClient.

Nested classes/interfaces inherited from class com.datastrato.gravitino.client.GravitinoClientBase

GravitinoClientBase.Builder<T>

Field Summary

Fields inherited from class com.datastrato.gravitino.client.GravitinoClientBase

API_METALAKES_IDENTIFIER_PATH, API_METALAKES_LIST_PATH, restClient

Method Summary

Modifier and Type	Method and Description
Catalog	alterCatalog(NameIdentifier ident, CatalogChange... changes) Alter a catalog with specified identifier.
static GravitinoClient.ClientBuilder	builder(java.lang.String uri) Creates a new builder for constructing a GravitinoClient.
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.

Methods inherited from class com.datastrato.gravitino.client.GravitinoClientBase

checkVersion, clientVersion, close, getVersion, loadMetalake, serverVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

Description copied from interface: SupportsCatalogs

List all catalogs in the metalake under the namespace Namespace.

Specified by:

listCatalogs in interface SupportsCatalogs

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

public Catalog[] listCatalogsInfo(Namespace namespace)
                           throws NoSuchMetalakeException

Description copied from interface: SupportsCatalogs

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

Specified by:

listCatalogsInfo in interface SupportsCatalogs

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

public Catalog loadCatalog(NameIdentifier ident)
                    throws NoSuchCatalogException

Description copied from interface: SupportsCatalogs

Load a catalog by its identifier.

Specified by:

loadCatalog in interface SupportsCatalogs

Parameters:

ident - the identifier of the catalog.

Returns:

The catalog.

Throws:

NoSuchCatalogException - If the catalog 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

Description copied from interface: SupportsCatalogs

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.

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 does not exist.

CatalogAlreadyExistsException - If the catalog already exists.

alterCatalog

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

Description copied from interface: SupportsCatalogs

Alter a catalog with specified identifier.

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 does not exist.

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

dropCatalog

public boolean dropCatalog(NameIdentifier ident)

Description copied from interface: SupportsCatalogs

Drop a catalog with specified identifier.

Specified by:

dropCatalog in interface SupportsCatalogs

Parameters:

ident - the identifier of the catalog.

Returns:

True if the catalog was dropped, false otherwise.

builder

public static GravitinoClient.ClientBuilder builder(java.lang.String uri)

Creates a new builder for constructing a GravitinoClient.

Parameters:

uri - The base URI for the Gravitino API.

Returns:

A new instance of the Builder class for constructing a GravitinoClient.