Package org.apache.flink.table.catalog

Interface CatalogBaseTable

All Known Subinterfaces:

CatalogMaterializedTable, CatalogTable, CatalogView, ResolvedCatalogBaseTable<T>

All Known Implementing Classes:

DefaultCatalogMaterializedTable, DefaultCatalogTable, ResolvedCatalogMaterializedTable, ResolvedCatalogTable, ResolvedCatalogView

@PublicEvolving
public interface CatalogBaseTable

A common parent that describes the unresolved metadata of a table or view in a catalog.

See Also:

• CatalogTable
• CatalogView

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CatalogBaseTable.TableKind	The kind of CatalogBaseTable.

Method Summary

Modifier and Type	Method	Description
CatalogBaseTable	copy()	Get a deep copy of the CatalogBaseTable instance.
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.
Map<String,String>	getOptions()	Returns a map of string-based options.
default TableSchema	getSchema()	Deprecated. This method returns the deprecated TableSchema class.
CatalogBaseTable.TableKind	getTableKind()	The kind of table this CatalogBaseTable describes.
default Schema	getUnresolvedSchema()	Returns the schema of the table or view.

Method Details

getTableKind

CatalogBaseTable.TableKind getTableKind()

The kind of table this CatalogBaseTable describes.

getOptions

Map<String,String> getOptions()

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.

getSchema

@Deprecated
default TableSchema getSchema()

Deprecated.

This method returns the deprecated TableSchema class. The old class was a hybrid of resolved and unresolved schema information. It has been replaced by the new Schema which is always unresolved and will be resolved by the framework later.

getUnresolvedSchema

default Schema getUnresolvedSchema()

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.

See Also:

• ResolvedCatalogTable
• ResolvedCatalogView

getComment

String getComment()

Get comment of the table or view.

Returns:

comment of the table/view.

copy

CatalogBaseTable copy()

Get a deep copy of the CatalogBaseTable instance.

Returns:

a copy of the CatalogBaseTable instance

getDescription

Optional<String> getDescription()

Get a brief description of the table or view.

Returns:

an optional short description of the table/view

getDetailedDescription

Optional<String> getDetailedDescription()

Get a detailed description of the table or view.

Returns:

an optional long description of the table/view