com.datastrato.gravitino.client

Class MessagingCatalog

java.lang.Object

com.datastrato.gravitino.dto.CatalogDTO

com.datastrato.gravitino.client.MessagingCatalog

All Implemented Interfaces:

Auditable, Catalog, TopicCatalog, SupportsSchemas

public class MessagingCatalog
extends CatalogDTO
implements TopicCatalog

Messaging catalog is a catalog implementation that supports messaging-like metadata operations, for example, topics list, creation, update and deletion. A Messaging 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.
Topic	alterTopic(NameIdentifier ident, TopicChange... changes) Alter the topic with the given identifier.
SupportsSchemas	asSchemas() Return the SupportsSchemas if the catalog supports schema operations.
TopicCatalog	asTopicCatalog()
static com.datastrato.gravitino.client.MessagingCatalog.Builder	builder()
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.
Topic	createTopic(NameIdentifier ident, java.lang.String comment, DataLayout dataLayout, java.util.Map<java.lang.String,java.lang.String> properties) Create a new topic with the given identifier, comment, data layout and properties.
boolean	dropSchema(NameIdentifier ident, boolean cascade) Drop the schema with specified identifier.
boolean	dropTopic(NameIdentifier ident) Drop the topic with the given identifier.
NameIdentifier[]	listSchemas(Namespace namespace) List all the schemas under the given catalog namespace.
NameIdentifier[]	listTopics(Namespace namespace) List all the topics under the given namespace.
Schema	loadSchema(NameIdentifier ident) Load the schema with specified identifier.
Topic	loadTopic(NameIdentifier ident) Load the topic with the given 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.messaging.TopicCatalog

topicExists

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

schemaExists

Methods inherited from interface com.datastrato.gravitino.Catalog

asFilesetCatalog, asTableCatalog

Field Detail

restClient

protected final RESTClient restClient

The REST client to send the requests.

Method Detail

builder

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

Returns:

A new builder for MessagingCatalog.

asTopicCatalog

public TopicCatalog asTopicCatalog()
                            throws java.lang.UnsupportedOperationException

Specified by:

asTopicCatalog in interface Catalog

Returns:

the TopicCatalog if the catalog supports topic operations.

Throws:

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

listTopics

public NameIdentifier[] listTopics(Namespace namespace)
                            throws NoSuchSchemaException

List all the topics under the given namespace.

Specified by:

listTopics in interface TopicCatalog

Parameters:

namespace - The namespace to list the topics under it.

Returns:

An array of NameIdentifier of the topics under the specified namespace.

Throws:

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

loadTopic

public Topic loadTopic(NameIdentifier ident)
                throws NoSuchTopicException

Load the topic with the given identifier.

Specified by:

loadTopic in interface TopicCatalog

Parameters:

ident - The identifier of the topic to load.

Returns:

The Topic with the specified identifier.

Throws:

NoSuchTopicException - if the topic with the specified identifier does not exist.

createTopic

public Topic createTopic(NameIdentifier ident,
                         java.lang.String comment,
                         DataLayout dataLayout,
                         java.util.Map<java.lang.String,java.lang.String> properties)
                  throws NoSuchSchemaException,
                         TopicAlreadyExistsException

Create a new topic with the given identifier, comment, data layout and properties.

Specified by:

createTopic in interface TopicCatalog

Parameters:

ident - A topic identifier.

comment - The comment of the topic object. Null is set if no comment is specified.

dataLayout - The message schema of the topic object. Always null because it's not supported yet.

properties - The properties of the topic object. Empty map is set if no properties are specified.

Returns:

The created topic object.

Throws:

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

TopicAlreadyExistsException - if the topic with specified identifier already exists.

alterTopic

public Topic alterTopic(NameIdentifier ident,
                        TopicChange... changes)
                 throws NoSuchTopicException,
                        java.lang.IllegalArgumentException

Alter the topic with the given identifier.

Specified by:

alterTopic in interface TopicCatalog

Parameters:

ident - A topic identifier.

changes - The changes to apply to the topic.

Returns:

The altered topic object.

Throws:

NoSuchTopicException - if the topic with the specified identifier does not exist.

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

dropTopic

public boolean dropTopic(NameIdentifier ident)

Drop the topic with the given identifier.

Specified by:

dropTopic in interface TopicCatalog

Parameters:

ident - A topic identifier.

Returns:

True if the topic is dropped successfully, false the topic does not exist.

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.