org.apache.flink.table.catalog

Class AbstractCatalogTable

java.lang.Object

org.apache.flink.table.catalog.AbstractCatalogTable

All Implemented Interfaces:

CatalogBaseTable, CatalogTable

Direct Known Subclasses:

CatalogTableImpl, ConnectorCatalogTable

@Internal
public abstract class AbstractCatalogTable
extends Object
implements CatalogTable

An abstract catalog table.

Nested Class Summary

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

CatalogTable.Builder

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

CatalogBaseTable.TableKind

Constructor Summary

Constructors

Constructor and Description
AbstractCatalogTable(TableSchema tableSchema, List<String> partitionKeys, Map<String,String> options, String comment)
AbstractCatalogTable(TableSchema tableSchema, Map<String,String> options, String comment)

Method Summary

Modifier and Type	Method and Description
String	getComment() Get comment of the table or view.
Map<String,String>	getOptions() Returns a map of string-based options.
List<String>	getPartitionKeys() Get the partition keys of the table.
TableSchema	getSchema()
boolean	isPartitioned() Check if the table is partitioned or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

copy, fromProperties, getDistribution, getSnapshot, getTableKind, newBuilder, of, of, toProperties

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

copy, getDescription, getDetailedDescription, getUnresolvedSchema

Constructor Detail

AbstractCatalogTable

public AbstractCatalogTable(TableSchema tableSchema,
                            Map<String,String> options,
                            String comment)

AbstractCatalogTable

public AbstractCatalogTable(TableSchema tableSchema,
                            List<String> partitionKeys,
                            Map<String,String> options,
                            String comment)

Method Detail

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

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

getSchema

public TableSchema getSchema()

Specified by:

getSchema in interface CatalogBaseTable

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.