Package org.apache.flink.table.catalog

Interface CatalogTable

All Superinterfaces:

CatalogBaseTable

All Known Implementing Classes:

AbstractCatalogTable, CatalogTableImpl, ConnectorCatalogTable, DefaultCatalogTable, ExternalCatalogTable, ResolvedCatalogTable

@PublicEvolving
public interface CatalogTable
extends CatalogBaseTable

Represents the unresolved metadata of a table in a Catalog.

It contains all characteristics that can be expressed in a SQL CREATE TABLE statement. The framework will resolve instances of this interface to a ResolvedCatalogTable before passing it to a DynamicTableFactory for creating a connector to an external system.

A catalog implementer can either use of(Schema, String, List, Map) for a basic implementation of this interface or create a custom class that allows passing catalog-specific objects all the way down to the connector creation (if necessary).

Note: The default implementation that is available via of(Schema, String, List, Map) is always serializable. For example, it can be used for implementing a catalog that uses ResolvedCatalogTable.toProperties() or for persisting compiled plans. An implementation of this interface determines whether a catalog table can be serialized by providing a proper CatalogBaseTable.getOptions() method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CatalogTable.Builder	Builder for configuring and creating instances of CatalogTable.

Nested classes/interfaces inherited from interface org.apache.flink.table.catalog.CatalogBaseTable

CatalogBaseTable.TableKind

Method Summary

Modifier and Type	Method	Description
CatalogTable	copy(Map<String,String> options)	Returns a copy of this CatalogTable with given table options options.
static CatalogTable	fromProperties(Map<String,String> properties)	Creates an instance of CatalogTable from a map of string properties that were previously created with ResolvedCatalogTable.toProperties().
default Optional<TableDistribution>	getDistribution()	Returns the distribution of the table if the DISTRIBUTED clause is defined.
List<String>	getPartitionKeys()	Get the partition keys of the table.
default Optional<Long>	getSnapshot()	Return the snapshot specified for the table.
default CatalogBaseTable.TableKind	getTableKind()	The kind of table this CatalogBaseTable describes.
boolean	isPartitioned()	Check if the table is partitioned or not.
static CatalogTable.Builder	newBuilder()	Builder for configuring and creating instances of CatalogTable.
static CatalogTable	of(Schema schema, String comment, List<String> partitionKeys, Map<String,String> options)	Deprecated. Use the builder newBuilder() instead.
static CatalogTable	of(Schema schema, String comment, List<String> partitionKeys, Map<String,String> options, Long snapshot)	Deprecated. Use the builder newBuilder() instead.
default Map<String,String>	toProperties()	Deprecated. Only a ResolvedCatalogTable is serializable to properties.

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

copy, getComment, getDescription, getDetailedDescription, getOptions, getSchema, getUnresolvedSchema

Method Detail

newBuilder

@PublicEvolving
static CatalogTable.Builder newBuilder()

Builder for configuring and creating instances of CatalogTable.

of

@Deprecated
static CatalogTable of(Schema schema,
                       @Nullable
                       String comment,
                       List<String> partitionKeys,
                       Map<String,String> options)

Deprecated.

Use the builder newBuilder() instead.

Creates a basic implementation of this interface.

The signature is similar to a SQL CREATE TABLE statement.

Parameters:

schema - unresolved schema

comment - optional comment

partitionKeys - list of partition keys or an empty list if not partitioned

options - options to configure the connector

of

@Deprecated
static CatalogTable of(Schema schema,
                       @Nullable
                       String comment,
                       List<String> partitionKeys,
                       Map<String,String> options,
                       @Nullable
                       Long snapshot)

Deprecated.

Use the builder newBuilder() instead.

Creates an instance of CatalogTable with a specific snapshot.

Parameters:

schema - unresolved schema

comment - optional comment

partitionKeys - list of partition keys or an empty list if not partitioned

options - options to configure the connector

snapshot - table snapshot of the table

fromProperties

static CatalogTable fromProperties(Map<String,String> properties)

Creates an instance of CatalogTable from a map of string properties that were previously created with ResolvedCatalogTable.toProperties().

Note that the serialization and deserialization of catalog tables are not symmetric. The framework will resolve functions and perform other validation tasks. A catalog implementation must not deal with this during a read operation.

Parameters:

properties - serialized version of a CatalogTable that includes schema, partition keys, and connector options

getTableKind

default CatalogBaseTable.TableKind getTableKind()

Description copied from interface: CatalogBaseTable

The kind of table this CatalogBaseTable describes.

Specified by:

getTableKind in interface CatalogBaseTable

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

@Deprecated
default Map<String,String> toProperties()

Deprecated.

Only a ResolvedCatalogTable is serializable to properties.

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.

getSnapshot

default Optional<Long> getSnapshot()

Return the snapshot specified for the table. Return Optional.empty() if not specified.

getDistribution

default Optional<TableDistribution> getDistribution()

Returns the distribution of the table if the DISTRIBUTED clause is defined.