org.apache.flink.table.catalog

Interface CatalogTable

All Superinterfaces:

CatalogBaseTable

All Known Implementing Classes:

AbstractCatalogTable, CatalogTableImpl, ConnectorCatalogTable

public interface CatalogTable
extends CatalogBaseTable

Represents a table in a catalog.

Method Summary

Modifier and Type	Method and Description
CatalogTable	copy(Map<String,String> options) Returns a copy of this CatalogTable with given table options options.
List<String>	getPartitionKeys() Get the partition keys of the table.
boolean	isPartitioned() Check if the table is partitioned or not.
Map<String,String>	toProperties() Serializes this instance into a map of string-based properties.

Methods inherited from interface org.apache.flink.table.catalog.CatalogBaseTable

copy, getComment, getDescription, getDetailedDescription, getOptions, getProperties, getSchema

Method Detail

isPartitioned

boolean isPartitioned()

Check if the table is partitioned or not.

Returns:

true if the table is partitioned; otherwise, false

getPartitionKeys

List<String> getPartitionKeys()

Get the partition keys of the table. This will be an empty set if the table is not partitioned.

Returns:

partition keys of the table

copy

CatalogTable copy(Map<String,String> options)

Returns a copy of this CatalogTable with given table options options.

Returns:

a new copy of this table with replaced table options

toProperties

Map<String,String> toProperties()

Serializes this instance into a map of string-based properties.

Compared to the pure table options in CatalogBaseTable.getOptions(), the map includes schema, partitioning, and other characteristics in a serialized form.