Package org.apache.flink.table.catalog

Class DefaultCatalogTable

java.lang.Object

org.apache.flink.table.catalog.DefaultCatalogTable

All Implemented Interfaces:

CatalogBaseTable, CatalogTable

@Internal
public class DefaultCatalogTable
extends Object
implements CatalogTable

Default implementation of a CatalogTable.

Nested Class Summary

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

CatalogBaseTable.TableKind

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

CatalogTable.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultCatalogTable(Schema schema, String comment, List<String> partitionKeys, Map<String,String> options)
protected	DefaultCatalogTable(Schema schema, String comment, List<String> partitionKeys, Map<String,String> options, Long snapshot, TableDistribution distribution)

Method Summary

Modifier and Type	Method	Description
CatalogBaseTable	copy()	Get a deep copy of the CatalogBaseTable instance.
CatalogTable	copy(Map<String,String> options)	Returns a copy of this CatalogTable with given table options options.
boolean	equals(Object o)
String	getComment()	Get comment of the table or view.
Optional<String>	getDescription()	Get a brief description of the table or view.
Optional<String>	getDetailedDescription()	Get a detailed description of the table or view.
Optional<TableDistribution>	getDistribution()	Returns the distribution of the table if the DISTRIBUTED clause is defined.
Map<String,String>	getOptions()	Returns a map of string-based options.
List<String>	getPartitionKeys()	Get the partition keys of the table.
Optional<Long>	getSnapshot()	Return the snapshot specified for the table.
Schema	getUnresolvedSchema()	Returns the schema of the table or view.
int	hashCode()
boolean	isPartitioned()	Check if the table is partitioned or not.
Map<String,String>	toProperties()	Serializes this instance into a map of string-based properties.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getSchema

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

getTableKind

Constructor Detail

DefaultCatalogTable

protected DefaultCatalogTable(Schema schema,
                              @Nullable
                              String comment,
                              List<String> partitionKeys,
                              Map<String,String> options)

DefaultCatalogTable

protected DefaultCatalogTable(Schema schema,
                              @Nullable
                              String comment,
                              List<String> partitionKeys,
                              Map<String,String> options,
                              @Nullable
                              Long snapshot,
                              @Nullable
                              TableDistribution distribution)

Method Detail

getUnresolvedSchema

public Schema getUnresolvedSchema()

Description copied from interface: CatalogBaseTable

Returns the schema of the table or view.

The schema can reference objects from other catalogs and will be resolved and validated by the framework when accessing the table or view.

Specified by:

getUnresolvedSchema in interface CatalogBaseTable

See Also:

ResolvedCatalogTable, ResolvedCatalogView

getComment

public String getComment()

Description copied from interface: CatalogBaseTable

Get comment of the table or view.

Specified by:

getComment in interface CatalogBaseTable

Returns:

comment of the table/view.

isPartitioned

public boolean isPartitioned()

Description copied from interface: CatalogTable

Check if the table is partitioned or not.

Specified by:

isPartitioned in interface CatalogTable

Returns:

true if the table is partitioned; otherwise, false

getPartitionKeys

public List<String> getPartitionKeys()

Description copied from interface: CatalogTable

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

Specified by:

getPartitionKeys in interface CatalogTable

Returns:

partition keys of the table

getDistribution

public Optional<TableDistribution> getDistribution()

Description copied from interface: CatalogTable

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

Specified by:

getDistribution in interface CatalogTable

getOptions

public Map<String,String> getOptions()

Description copied from interface: CatalogBaseTable

Returns a map of string-based options.

In case of CatalogTable, these options may determine the kind of connector and its configuration for accessing the data in the external system. See DynamicTableFactory for more information. If a CatalogTable should not be serializable, an implementation can simply throw a runtime exception in this method.

Specified by:

getOptions in interface CatalogBaseTable

getSnapshot

public Optional<Long> getSnapshot()

Description copied from interface: CatalogTable

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

Specified by:

getSnapshot in interface CatalogTable

copy

public CatalogBaseTable copy()

Description copied from interface: CatalogBaseTable

Get a deep copy of the CatalogBaseTable instance.

Specified by:

copy in interface CatalogBaseTable

Returns:

a copy of the CatalogBaseTable instance

copy

public CatalogTable copy(Map<String,String> options)

Description copied from interface: CatalogTable

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

Specified by:

copy in interface CatalogTable

Returns:

a new copy of this table with replaced table options

getDescription

public Optional<String> getDescription()

Description copied from interface: CatalogBaseTable

Get a brief description of the table or view.

Specified by:

getDescription in interface CatalogBaseTable

Returns:

an optional short description of the table/view

getDetailedDescription

public Optional<String> getDetailedDescription()

Description copied from interface: CatalogBaseTable

Get a detailed description of the table or view.

Specified by:

getDetailedDescription in interface CatalogBaseTable

Returns:

an optional long description of the table/view

toProperties

public Map<String,String> toProperties()

Description copied from interface: CatalogTable

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.

Specified by:

toProperties in interface CatalogTable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object