com.datastrato.gravitino.client

Class RelationalCatalog

java.lang.Object

com.datastrato.gravitino.dto.CatalogDTO

com.datastrato.gravitino.client.RelationalCatalog

All Implemented Interfaces:

Auditable, Catalog, SupportsSchemas, TableCatalog

public class RelationalCatalog
extends CatalogDTO
implements TableCatalog

Relational catalog is a catalog implementation that supports relational database like metadata operations, for example, schemas and tables list, creation, update and deletion. A Relational catalog is under the metalake.

Nested Class Summary

Nested classes/interfaces inherited from interface com.datastrato.gravitino.Catalog

Catalog.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected RESTClient	restClient The REST client to send the requests.

Fields inherited from interface com.datastrato.gravitino.Catalog

PROPERTY_PACKAGE

Method Summary

Modifier and Type	Method and Description
Schema	alterSchema(NameIdentifier ident, SchemaChange... changes) Alter the schema with specified identifier by applying the changes.
Table	alterTable(NameIdentifier ident, TableChange... changes) Alter the table with specified identifier by applying the changes.
SupportsSchemas	asSchemas() Return the SupportsSchemas if the catalog supports schema operations.
TableCatalog	asTableCatalog()
static com.datastrato.gravitino.client.RelationalCatalog.Builder	builder() Create a new builder for the relational catalog.
Schema	createSchema(NameIdentifier ident, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Create a new schema with specified identifier, comment and metadata.
Table	createTable(NameIdentifier ident, Column[] columns, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties, Transform[] partitioning, Distribution distribution, SortOrder[] sortOrders, Index[] indexes) Create a new table with specified identifier, columns, comment and properties.
boolean	dropSchema(NameIdentifier ident, boolean cascade) Drop the schema with specified identifier.
boolean	dropTable(NameIdentifier ident) Drop the table with specified identifier.
NameIdentifier[]	listSchemas(Namespace namespace) List all the schemas under the given catalog namespace.
NameIdentifier[]	listTables(Namespace namespace) List all the tables under the given Schema namespace.
Schema	loadSchema(NameIdentifier ident) Load the schema with specified identifier.
Table	loadTable(NameIdentifier ident) Load the table with specified identifier.
boolean	purgeTable(NameIdentifier ident) Purge the table with specified identifier.

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

auditInfo, comment, name, properties, provider, type

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.rel.TableCatalog

createTable, createTable, createTable, createTable, createTable, createTable, tableExists

Methods inherited from interface com.datastrato.gravitino.rel.SupportsSchemas

schemaExists

Methods inherited from interface com.datastrato.gravitino.Catalog

asFilesetCatalog, asTopicCatalog

Field Detail

restClient

protected final RESTClient restClient

The REST client to send the requests.

Method Detail

asTableCatalog

public TableCatalog asTableCatalog()

Specified by:

asTableCatalog in interface Catalog

Returns:

the TableCatalog if the catalog supports table operations.

listTables

public NameIdentifier[] listTables(Namespace namespace)
                            throws NoSuchSchemaException

List all the tables under the given Schema namespace.

Specified by:

listTables in interface TableCatalog

Parameters:

namespace - The namespace to list the tables under it.

Returns:

A list of NameIdentifier of the tables under the given namespace.

Throws:

NoSuchSchemaException - if the schema with specified namespace does not exist.

loadTable

public Table loadTable(NameIdentifier ident)
                throws NoSuchTableException

Load the table with specified identifier.

Specified by:

loadTable in interface TableCatalog

Parameters:

ident - The identifier of the table to load.

Returns:

The Table with specified identifier.

Throws:

NoSuchTableException - if the table with specified identifier does not exist.

createTable

public Table createTable(NameIdentifier ident,
                         Column[] columns,
                         java.lang.String comment,
                         java.util.Map<java.lang.String,java.lang.String> properties,
                         Transform[] partitioning,
                         Distribution distribution,
                         SortOrder[] sortOrders,
                         Index[] indexes)
                  throws NoSuchSchemaException,
                         TableAlreadyExistsException

Create a new table with specified identifier, columns, comment and properties.

Specified by:

createTable in interface TableCatalog

Parameters:

ident - The identifier of the table.

columns - The columns of the table.

comment - The comment of the table.

properties - The properties of the table.

partitioning - The partitioning of the table.

indexes - The indexes of the table.

distribution - The distribution of the table

sortOrders - The sort orders of the table

Returns:

The created Table.

Throws:

NoSuchSchemaException - if the schema with specified namespace does not exist.

TableAlreadyExistsException - if the table with specified identifier already exists.

alterTable

public Table alterTable(NameIdentifier ident,
                        TableChange... changes)
                 throws NoSuchTableException,
                        java.lang.IllegalArgumentException

Alter the table with specified identifier by applying the changes.

Specified by:

alterTable in interface TableCatalog

Parameters:

ident - The identifier of the table.

changes - Table changes to apply to the table.

Returns:

The altered Table.

Throws:

NoSuchTableException - if the table with specified identifier does not exist.

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

dropTable

public boolean dropTable(NameIdentifier ident)

Drop the table with specified identifier.

Specified by:

dropTable in interface TableCatalog

Parameters:

ident - The identifier of the table.

Returns:

true if the table is dropped successfully, false otherwise.

purgeTable

public boolean purgeTable(NameIdentifier ident)
                   throws java.lang.UnsupportedOperationException

Purge the table with specified identifier.

Specified by:

purgeTable in interface TableCatalog

Parameters:

ident - The identifier of the table.

Returns:

true if the table is purged successfully, false otherwise.

Throws:

java.lang.UnsupportedOperationException - If the catalog does not support to purge a table.

builder

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

Create a new builder for the relational catalog.

Returns:

A new builder for the relational catalog.

asSchemas

public SupportsSchemas asSchemas()
                          throws java.lang.UnsupportedOperationException

Description copied from interface: Catalog

Return the SupportsSchemas if the catalog supports schema operations.

Specified by:

asSchemas in interface Catalog

Returns:

The SupportsSchemas if the catalog supports schema operations.

Throws:

java.lang.UnsupportedOperationException - if the catalog does not support schema operations.

listSchemas

public NameIdentifier[] listSchemas(Namespace namespace)
                             throws NoSuchCatalogException

List all the schemas under the given catalog namespace.

Specified by:

listSchemas in interface SupportsSchemas

Parameters:

namespace - The namespace of the catalog.

Returns:

A list of NameIdentifier of the schemas under the given catalog namespace.

Throws:

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

createSchema

public Schema createSchema(NameIdentifier ident,
                           java.lang.String comment,
                           java.util.Map<java.lang.String,java.lang.String> properties)
                    throws NoSuchCatalogException,
                           SchemaAlreadyExistsException

Create a new schema with specified identifier, comment and metadata.

Specified by:

createSchema in interface SupportsSchemas

Parameters:

ident - The name identifier of the schema.

comment - The comment of the schema.

properties - The properties of the schema.

Returns:

The created Schema.

Throws:

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

SchemaAlreadyExistsException - if the schema with specified identifier already exists.

loadSchema

public Schema loadSchema(NameIdentifier ident)
                  throws NoSuchSchemaException

Load the schema with specified identifier.

Specified by:

loadSchema in interface SupportsSchemas

Parameters:

ident - The name identifier of the schema.

Returns:

The Schema with specified identifier.

Throws:

NoSuchSchemaException - if the schema with specified identifier does not exist.

alterSchema

public Schema alterSchema(NameIdentifier ident,
                          SchemaChange... changes)
                   throws NoSuchSchemaException

Alter the schema with specified identifier by applying the changes.

Specified by:

alterSchema in interface SupportsSchemas

Parameters:

ident - The name identifier of the schema.

changes - The metadata changes to apply.

Returns:

The altered Schema.

Throws:

NoSuchSchemaException - if the schema with specified identifier does not exist.

dropSchema

public boolean dropSchema(NameIdentifier ident,
                          boolean cascade)
                   throws NonEmptySchemaException

Drop the schema with specified identifier.

Specified by:

dropSchema in interface SupportsSchemas

Parameters:

ident - The name identifier of the schema.

cascade - Whether to drop all the tables under the schema.

Returns:

true if the schema is dropped successfully, false otherwise.

Throws:

NonEmptySchemaException - if the schema is not empty and cascade is false.