Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_EXTERNAL	The property name to indicate whether the table is external.
static final String	PROPERTY_LOCATION	The property name for the table location.
static final String	PROPERTY_TABLE_FORMAT	The property name for the table format.

Method Summary

Modifier and Type	Method	Description
Column[]	columns()
default String	comment()
default Distribution	distribution()
default Index[]	index()
String	name()
default Transform[]	partitioning()
default Map<String,String>	properties()
default SortOrder[]	sortOrder()
default SupportsPartitions	supportPartitions()	Table method for working with partitions.
default SupportsPartitionStatistics	supportsPartitionStatistics()	Returns the SupportsPartitionStatistics if the table supports partition statistics
default SupportsPolicies	supportsPolicies()
default SupportsRoles	supportsRoles()
default SupportsStatistics	supportsStatistics()	Returns the SupportsStatistics if the table supports statistics operations.
default SupportsTags	supportsTags()

Methods inherited from interface org.apache.gravitino.Auditable

auditInfo

Field Details

PROPERTY_TABLE_FORMAT

static final String PROPERTY_TABLE_FORMAT

The property name for the table format. This property indicates the format of the table, such as "iceberg", "hudi", "lance", etc. generic lakehouse catalog will use this property to determine the table format and perform specific operations based on the format. For other relational catalogs, this property can be ignored.

This property is a must-have property for generic lakehouse catalog to create tables, and cannot be modified after table creation.

Current supported formats include:

• lance

See Also:

• Constant Field Values

PROPERTY_EXTERNAL

static final String PROPERTY_EXTERNAL

The property name to indicate whether the table is external. This property is a boolean value represented as a string ("true" or "false"). if true (the table is external), the drop operation will not delete the underlying data.

This property is optional and defaults to "false" if not specified. Also, it depends on the catalog implementation to decide whether to leverage and allow to alter this property.

See Also:

• Constant Field Values

PROPERTY_LOCATION

static final String PROPERTY_LOCATION

The property name for the table location. This property indicates the physical location of the table's data, such as a file path or a URI.

The location property is optional, it can be specified when creating the table. If not, the catalog implementation may use a location based on the catalog and schema location properties.

It depends on the catalog implementation to decide whether to leverage and allow to alter this property after table creation. And the behavior of altering this property (moving the table data) is also catalog specific.

See Also:

• Constant Field Values

Method Details

name

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 String comment()

Returns:

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

properties

default Map<String,String> properties()

Returns:

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

supportPartitions

default SupportsPartitions supportPartitions()
                                      throws 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:

UnsupportedOperationException - If the table does not support partition operations.

supportsTags

default SupportsTags supportsTags()

Returns:

The SupportsTags if the table supports tag operations.

Throws:

UnsupportedOperationException - If the table does not support tag operations.

supportsPolicies

default SupportsPolicies supportsPolicies()

Returns:

The SupportsPolicies if the table supports policy operations.

Throws:

UnsupportedOperationException - If the table does not support policy operations.

supportsRoles

default SupportsRoles supportsRoles()

Returns:

The SupportsRoles if the table supports role operations.

Throws:

UnsupportedOperationException - If the table does not support role operations.

supportsStatistics

default SupportsStatistics supportsStatistics()

Returns the SupportsStatistics if the table supports statistics operations.

Returns:

The SupportsStatistics for the table.

supportsPartitionStatistics

default SupportsPartitionStatistics supportsPartitionStatistics()

Returns the SupportsPartitionStatistics if the table supports partition statistics

Returns:

The SupportsPartitionStatistics for the table.