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.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	comment()
java.lang.String	name()
default java.util.Map<java.lang.String,java.lang.String>	properties()
default SupportsRoles	supportsRoles()
default SupportsTags	supportsTags()

Methods inherited from interface org.apache.gravitino.Auditable

auditInfo

Method Detail

name

java.lang.String name()

Returns:

The name of the Schema.

comment

@Nullable
default java.lang.String comment()

Returns:

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

properties

default java.util.Map<java.lang.String,java.lang.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:

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

supportsRoles

default SupportsRoles supportsRoles()

Returns:

the SupportsRoles if the schema supports role operations.

Throws:

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