org.apache.gravitino.rel

Interface Table

All Superinterfaces:

Auditable

All Known Implementing Classes:

TableDTO

@Evolving
public interface Table
extends Auditable

An interface representing a table in a Namespace. It defines the basic properties of a table. A catalog implementation with TableCatalog should implement this interface.

Method Summary

Modifier and Type	Method and Description
Column[]	columns()
default java.lang.String	comment()
default Distribution	distribution()
default Index[]	index()
java.lang.String	name()
default Transform[]	partitioning()
default java.util.Map<java.lang.String,java.lang.String>	properties()
default SortOrder[]	sortOrder()
default SupportsPartitions	supportPartitions() Table method for working with partitions.
default SupportsRoles	supportsRoles()
default SupportsTags	supportsTags()

Methods inherited from interface org.apache.gravitino.Auditable

auditInfo

Method Detail

name

java.lang.String name()

Returns:

Name of the table.

columns

Column[] columns()

Returns:

The columns of the table.

partitioning

default Transform[] partitioning()

Returns:

The physical partitioning of the table.

sortOrder

default SortOrder[] sortOrder()

Returns:

The sort order of the table. If no sort order is specified, an empty array is returned.

distribution

default Distribution distribution()

Returns:

The bucketing of the table. If no bucketing is specified, Distribution.NONE is returned.

index

default Index[] index()

Returns:

The indexes of the table. If no indexes are specified, Indexes.EMPTY_INDEXES is returned.

comment

@Nullable
default java.lang.String comment()

Returns:

The comment of the table. Null is returned if no comment is set.

properties

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

Returns:

The properties of the table. Empty map is returned if no properties are set.

supportPartitions

default SupportsPartitions supportPartitions()
                                      throws java.lang.UnsupportedOperationException

Table method for working with partitions. If the table does not support partition operations, an UnsupportedOperationException is thrown.

Returns:

The partition support table.

Throws:

java.lang.UnsupportedOperationException - If the table does not support partition operations.

supportsTags

default SupportsTags supportsTags()

Returns:

The SupportsTags if the table supports tag operations.

Throws:

java.lang.UnsupportedOperationException - If the table does not support tag operations.

supportsRoles

default SupportsRoles supportsRoles()

Returns:

The SupportsRoles if the table supports role operations.

Throws:

java.lang.UnsupportedOperationException - If the table does not support role operations.