Package org.apache.gravitino

Enum Class Catalog.Type

java.lang.Object

java.lang.Enum<Catalog.Type>

org.apache.gravitino.Catalog.Type

All Implemented Interfaces:

Serializable, Comparable<Catalog.Type>, Constable

Enclosing interface:

Catalog

public static enum Catalog.Type
extends Enum<Catalog.Type>

The type of the catalog.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILESET	Catalog Type for Fileset System (including HDFS, S3, etc.), like path/to/file
MESSAGING	Catalog Type for Message Queue, like Kafka://topic
MODEL	Catalog Type for ML model
RELATIONAL	Catalog Type for Relational Data Structure, like db.table, catalog.db.table.
UNSUPPORTED	Catalog Type for test only.

Method Summary

Modifier and Type	Method	Description
static Catalog.Type	fromString(String type)	Convert the string (case-insensitive) to the catalog type.
boolean	supportsManagedCatalog()	A flag to indicate whether the catalog type supports managed catalog.
static Catalog.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Catalog.Type[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RELATIONAL

public static final Catalog.Type RELATIONAL

Catalog Type for Relational Data Structure, like db.table, catalog.db.table.

FILESET

public static final Catalog.Type FILESET

Catalog Type for Fileset System (including HDFS, S3, etc.), like path/to/file

MESSAGING

public static final Catalog.Type MESSAGING

Catalog Type for Message Queue, like Kafka://topic

MODEL

public static final Catalog.Type MODEL

Catalog Type for ML model

UNSUPPORTED

public static final Catalog.Type UNSUPPORTED

Catalog Type for test only.

Method Details

values

public static Catalog.Type[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Catalog.Type valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

supportsManagedCatalog

public boolean supportsManagedCatalog()

A flag to indicate whether the catalog type supports managed catalog. Managed catalog is a concept in Gravitino, for the details of managed catalog, please refer to the class comment of CatalogProvider. If the catalog type supports managed catalog, users can create managed catalog of this type without specifying the provider, Gravitino will use the type as the provider to create the managed catalog. If the catalog type does not support managed catalog, users need to specify the provider when creating the catalog.

Currently, the model and fileset catalogs support managed catalog.

Returns:

Whether the catalog type supports managed catalog. Returns true if the catalog type supports managed catalog.

fromString

public static Catalog.Type fromString(String type)

Convert the string (case-insensitive) to the catalog type.

Parameters:

type - The string to convert

Returns:

The catalog type