com.datastrato.gravitino.client

Class FilesetCatalog

java.lang.Object

com.datastrato.gravitino.dto.CatalogDTO

com.datastrato.gravitino.client.FilesetCatalog

All Implemented Interfaces:

Auditable, Catalog, FilesetCatalog, SupportsSchemas

public class FilesetCatalog
extends CatalogDTO
implements FilesetCatalog

Fileset catalog is a catalog implementation that supports fileset like metadata operations, for example, schemas and filesets list, creation, update and deletion. A Fileset 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
Fileset	alterFileset(NameIdentifier ident, FilesetChange... changes) Update a fileset metadata in the catalog.
Schema	alterSchema(NameIdentifier ident, SchemaChange... changes) Alter the schema with specified identifier by applying the changes.
FilesetCatalog	asFilesetCatalog()
SupportsSchemas	asSchemas() Return the SupportsSchemas if the catalog supports schema operations.
static com.datastrato.gravitino.client.FilesetCatalog.Builder	builder() Create a new builder for the fileset catalog.
Fileset	createFileset(NameIdentifier ident, java.lang.String comment, Fileset.Type type, java.lang.String storageLocation, java.util.Map<java.lang.String,java.lang.String> properties) Create a fileset metadata in the 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.
boolean	dropFileset(NameIdentifier ident) Drop a fileset from the catalog.
boolean	dropSchema(NameIdentifier ident, boolean cascade) Drop the schema with specified identifier.
NameIdentifier[]	listFilesets(Namespace namespace) List the filesets in a schema namespace from the catalog.
NameIdentifier[]	listSchemas(Namespace namespace) List all the schemas under the given catalog namespace.
Fileset	loadFileset(NameIdentifier ident) Load fileset metadata by NameIdentifier from the catalog.
Schema	loadSchema(NameIdentifier ident) Load the schema 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.file.FilesetCatalog

filesetExists

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

schemaExists

Methods inherited from interface com.datastrato.gravitino.Catalog

asTableCatalog, asTopicCatalog

Field Detail

restClient

protected final RESTClient restClient

The REST client to send the requests.

Method Detail

asFilesetCatalog

public FilesetCatalog asFilesetCatalog()
                                throws java.lang.UnsupportedOperationException

Specified by:

asFilesetCatalog in interface Catalog

Returns:

the FilesetCatalog if the catalog supports fileset operations.

Throws:

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

listFilesets

public NameIdentifier[] listFilesets(Namespace namespace)
                              throws NoSuchSchemaException

List the filesets in a schema namespace from the catalog.

Specified by:

listFilesets in interface FilesetCatalog

Parameters:

namespace - A schema namespace.

Returns:

An array of fileset identifiers in the namespace.

Throws:

NoSuchSchemaException - If the schema does not exist.

loadFileset

public Fileset loadFileset(NameIdentifier ident)
                    throws NoSuchFilesetException

Load fileset metadata by NameIdentifier from the catalog.

Specified by:

loadFileset in interface FilesetCatalog

Parameters:

ident - A fileset identifier.

Returns:

The fileset metadata.

Throws:

NoSuchFilesetException - If the fileset does not exist.

createFileset

public Fileset createFileset(NameIdentifier ident,
                             java.lang.String comment,
                             Fileset.Type type,
                             java.lang.String storageLocation,
                             java.util.Map<java.lang.String,java.lang.String> properties)
                      throws NoSuchSchemaException,
                             FilesetAlreadyExistsException

Create a fileset metadata in the catalog.

If the type of the fileset object is "MANAGED", the underlying storageLocation can be null, and Gravitino will manage the storage location based on the location of the schema.

If the type of the fileset object is "EXTERNAL", the underlying storageLocation must be set.

Specified by:

createFileset in interface FilesetCatalog

Parameters:

ident - A fileset identifier.

comment - The comment of the fileset.

type - The type of the fileset.

storageLocation - The storage location of the fileset.

properties - The properties of the fileset.

Returns:

The created fileset metadata

Throws:

NoSuchSchemaException - If the schema does not exist.

FilesetAlreadyExistsException - If the fileset already exists.

alterFileset

public Fileset alterFileset(NameIdentifier ident,
                            FilesetChange... changes)
                     throws NoSuchFilesetException,
                            java.lang.IllegalArgumentException

Update a fileset metadata in the catalog.

Specified by:

alterFileset in interface FilesetCatalog

Parameters:

ident - A fileset identifier.

changes - The changes to apply to the fileset.

Returns:

The updated fileset metadata.

Throws:

NoSuchFilesetException - If the fileset does not exist.

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

dropFileset

public boolean dropFileset(NameIdentifier ident)

Drop a fileset from the catalog.

The underlying files will be deleted if this fileset type is managed, otherwise, only the metadata will be dropped.

Specified by:

dropFileset in interface FilesetCatalog

Parameters:

ident - A fileset identifier.

Returns:

true If the fileset is dropped, false the fileset did not exist.

builder

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

Create a new builder for the fileset catalog.

Returns:

A new builder for the fileset 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.