com.datastrato.gravitino

Interface Catalog

All Superinterfaces:

Auditable

All Known Implementing Classes:

CatalogDTO, RelationalCatalog

public interface Catalog
extends Auditable

The interface of a catalog. The catalog is the second level entity in the gravitino system, containing a set of tables.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Catalog.Type The type of the catalog.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_PACKAGE A reserved property to specify the package location of the catalog.

Method Summary

Modifier and Type	Method and Description
default SupportsSchemas	asSchemas() Return the SupportsSchemas if the catalog supports schema operations.
default TableCatalog	asTableCatalog()
java.lang.String	comment() The comment of the catalog.
java.lang.String	name()
java.util.Map<java.lang.String,java.lang.String>	properties() The properties of the catalog.
java.lang.String	provider()
Catalog.Type	type()

Methods inherited from interface com.datastrato.gravitino.Auditable

auditInfo

Field Detail

PROPERTY_PACKAGE

static final java.lang.String PROPERTY_PACKAGE

A reserved property to specify the package location of the catalog. The "package" is a string of path to the folder where all the catalog related dependencies is located. The dependencies under the "package" will be loaded by Gravitino to create the catalog.

The property "package" is not needed if the catalog is a built-in one, Gravitino will search the proper location using "provider" to load the dependencies. Only when the folder is in different location, the "package" property is needed.

See Also:

Constant Field Values

Method Detail

name

java.lang.String name()

Returns:

The name of the catalog.

type

Catalog.Type type()

Returns:

The type of the catalog.

provider

java.lang.String provider()

Returns:

The provider of the catalog.

comment

java.lang.String comment()

The comment of the catalog. Note. this method will return null if the comment is not set for this catalog.

Returns:

The comment of the catalog.

properties

java.util.Map<java.lang.String,java.lang.String> properties()

The properties of the catalog. Note, this method will return null if the properties are not set.

Returns:

The properties of the catalog.

asSchemas

default SupportsSchemas asSchemas()
                           throws java.lang.UnsupportedOperationException

Return the SupportsSchemas if the catalog supports schema operations.

Returns:

The SupportsSchemas if the catalog supports schema operations.

Throws:

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

asTableCatalog

default TableCatalog asTableCatalog()
                             throws java.lang.UnsupportedOperationException

Returns:

the TableCatalog if the catalog supports table operations.

Throws:

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