Package org.apache.gravitino

Interface Schema

All Superinterfaces:

Auditable

All Known Implementing Classes:

SchemaDTO

@Evolving
public interface Schema
extends Auditable

An interface representing a schema in the Catalog. A Schema is a basic container of relational objects, like tables, views, etc. A Schema can be self-nested, which means it can be schema1.schema2.table.

This defines the basic properties of a schema. A catalog implementation with SupportsSchemas should implement this interface.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_LOCATION	The property name for the location of the schema.

Method Summary

Modifier and Type	Method	Description
default String	comment()
String	name()
default Map<String,String>	properties()
default SupportsPolicies	supportsPolicies()
default SupportsRoles	supportsRoles()
default SupportsTags	supportsTags()

Methods inherited from interface org.apache.gravitino.Auditable

auditInfo

Field Details

PROPERTY_LOCATION

static final String PROPERTY_LOCATION

The property name for the location of the schema. This property indicates the physical storage location of the schema, such as a directory path in a file system or a URI.

This property is optional, and it can be specified during schema creation.

It depends on the catalog implementation to decide whether to use this property or not. It also depends on the catalog implementation to decide whether this property can be altered after schema creation. Besides, the behavior of altering this property (moving data or not) is also determined by the catalog implementation.

See Also:

• Constant Field Values

Method Details

name

String name()

Returns:

The name of the Schema.

comment

@Nullable
default String comment()

Returns:

The comment of the Schema. Null is returned if the comment is not set.

properties

default Map<String,String> properties()

Returns:

The properties of the Schema. An empty map is returned if no properties are set.

supportsTags

default SupportsTags supportsTags()

Returns:

the SupportsTags if the schema supports tag operations.

Throws:

UnsupportedOperationException - if the schema does not support tag operations.

supportsPolicies

default SupportsPolicies supportsPolicies()

Returns:

the SupportsPolicies if the schema supports policy operations.

Throws:

UnsupportedOperationException - if the schema does not support policy operations.

supportsRoles

default SupportsRoles supportsRoles()

Returns:

the SupportsRoles if the schema supports role operations.

Throws:

UnsupportedOperationException - if the schema does not support role operations.