org.apache.gravitino

Interface Catalog

All Superinterfaces:

Auditable

All Known Implementing Classes:

CatalogDTO

@Evolving
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. The server side should use the other one with the same name in the core module.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Catalog.CloudName The cloud that the catalog is running on.
static class	Catalog.Type The type of the catalog.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHORIZATION_PROVIDER This variable is used as a key in properties of catalogs to use authorization provider in Gravitino.
static java.lang.String	CLOUD_NAME The property to specify the cloud that the catalog is running on.
static java.lang.String	CLOUD_REGION_CODE The property to specify the region code of the cloud that the catalog is running on.
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 FilesetCatalog	asFilesetCatalog()
default SupportsSchemas	asSchemas() Return the SupportsSchemas if the catalog supports schema operations.
default TableCatalog	asTableCatalog()
default TopicCatalog	asTopicCatalog()
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()
default SupportsRoles	supportsRoles()
default SupportsTags	supportsTags()
Catalog.Type	type()

Methods inherited from interface org.apache.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

CLOUD_NAME

static final java.lang.String CLOUD_NAME

The property to specify the cloud that the catalog is running on. The value should be one of the Catalog.CloudName.

See Also:

Constant Field Values

CLOUD_REGION_CODE

static final java.lang.String CLOUD_REGION_CODE

The property to specify the region code of the cloud that the catalog is running on. The value should be the region code of the cloud provider.

See Also:

Constant Field Values

AUTHORIZATION_PROVIDER

static final java.lang.String AUTHORIZATION_PROVIDER

This variable is used as a key in properties of catalogs to use authorization provider in Gravitino.

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.

asFilesetCatalog

default FilesetCatalog asFilesetCatalog()
                                 throws java.lang.UnsupportedOperationException

Returns:

the FilesetCatalog if the catalog supports fileset operations.

Throws:

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

asTopicCatalog

default TopicCatalog asTopicCatalog()
                             throws java.lang.UnsupportedOperationException

Returns:

the TopicCatalog if the catalog supports topic operations.

Throws:

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

supportsTags

default SupportsTags supportsTags()
                           throws java.lang.UnsupportedOperationException

Returns:

the SupportsTags if the catalog supports tag operations.

Throws:

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

supportsRoles

default SupportsRoles supportsRoles()
                             throws java.lang.UnsupportedOperationException

Returns:

the SupportsRoles if the catalog supports role operations.

Throws:

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