Package org.apache.flink.table.catalog

Class ResolvedCatalogMaterializedTable

java.lang.Object

org.apache.flink.table.catalog.ResolvedCatalogMaterializedTable

All Implemented Interfaces:

CatalogBaseTable, CatalogMaterializedTable, ResolvedCatalogBaseTable<CatalogMaterializedTable>

@PublicEvolving
public class ResolvedCatalogMaterializedTable
extends Object
implements ResolvedCatalogBaseTable<CatalogMaterializedTable>, CatalogMaterializedTable

A validated CatalogMaterializedTable that is backed by the original metadata coming from the Catalog but resolved by the framework.

Note: This will be converted to ResolvedCatalogTable by framework during planner optimize query phase.

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.CatalogMaterializedTable

CatalogMaterializedTable.Builder, CatalogMaterializedTable.LogicalRefreshMode, CatalogMaterializedTable.RefreshMode, CatalogMaterializedTable.RefreshStatus

Constructor Summary

Constructors

Constructor	Description
ResolvedCatalogMaterializedTable(CatalogMaterializedTable origin, ResolvedSchema resolvedSchema)

Method Summary

Modifier and Type	Method	Description
CatalogBaseTable	copy()	Get a deep copy of the CatalogBaseTable instance.
ResolvedCatalogMaterializedTable	copy(Map<String,String> options)	Returns a copy of this CatalogMaterializedTable with given table options options.
ResolvedCatalogMaterializedTable	copy(CatalogMaterializedTable.RefreshStatus refreshStatus, String refreshHandlerDescription, byte[] serializedRefreshHandler)	Returns a copy of this CatalogDynamicTable with given refresh info.
boolean	equals(Object o)
String	getComment()	Get comment of the table or view.
IntervalFreshness	getDefinitionFreshness()	Get the definition freshness of materialized table which is used to determine the physical refresh mode.
String	getDefinitionQuery()	The definition query text of materialized table, text is expanded in contrast to the original SQL.
Optional<String>	getDescription()	Get a brief description of the table or view.
Optional<String>	getDetailedDescription()	Get a detailed description of the table or view.
CatalogMaterializedTable.LogicalRefreshMode	getLogicalRefreshMode()	Get the logical refresh mode of materialized table.
Map<String,String>	getOptions()	Returns a map of string-based options.
CatalogMaterializedTable	getOrigin()	Returns the original, unresolved metadata object from the Catalog.
List<String>	getPartitionKeys()	Get the partition keys of the table.
Optional<String>	getRefreshHandlerDescription()	Return summary description of refresh handler.
CatalogMaterializedTable.RefreshMode	getRefreshMode()	Get the physical refresh mode of materialized table.
CatalogMaterializedTable.RefreshStatus	getRefreshStatus()	Get the refresh status of materialized table.
ResolvedSchema	getResolvedSchema()	Returns a fully resolved and validated ResolvedSchema.
byte[]	getSerializedRefreshHandler()	Return the serialized refresh handler of materialized table.
Optional<Long>	getSnapshot()	Return the snapshot specified for the table.
int	hashCode()
boolean	isPartitioned()	Check if the table is partitioned or not.
ResolvedCatalogTable	toResolvedCatalogTable()	Convert this object to a ResolvedCatalogTable object for planner optimize query.
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

getUnresolvedSchema

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

getFreshness, getTableKind

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

getSchema

Constructor Detail

ResolvedCatalogMaterializedTable

public ResolvedCatalogMaterializedTable(CatalogMaterializedTable origin,
                                        ResolvedSchema resolvedSchema)

Method Detail

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

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.

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 ResolvedCatalogMaterializedTable copy(Map<String,String> options)

Description copied from interface: CatalogMaterializedTable

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

Specified by:

copy in interface CatalogMaterializedTable

Returns:

a new copy of this table with replaced table options

copy

public ResolvedCatalogMaterializedTable copy(CatalogMaterializedTable.RefreshStatus refreshStatus,
                                             String refreshHandlerDescription,
                                             byte[] serializedRefreshHandler)

Description copied from interface: CatalogMaterializedTable

Returns a copy of this CatalogDynamicTable with given refresh info.

Specified by:

copy in interface CatalogMaterializedTable

Returns:

a new copy of this table with replaced refresh info

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

isPartitioned

public boolean isPartitioned()

Description copied from interface: CatalogMaterializedTable

Check if the table is partitioned or not.

Specified by:

isPartitioned in interface CatalogMaterializedTable

Returns:

true if the table is partitioned; otherwise, false

getPartitionKeys

public List<String> getPartitionKeys()

Description copied from interface: CatalogMaterializedTable

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

Specified by:

getPartitionKeys in interface CatalogMaterializedTable

Returns:

partition keys of the table

getSnapshot

public Optional<Long> getSnapshot()

Description copied from interface: CatalogMaterializedTable

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

Specified by:

getSnapshot in interface CatalogMaterializedTable

getOrigin

public CatalogMaterializedTable getOrigin()

Description copied from interface: ResolvedCatalogBaseTable

Returns the original, unresolved metadata object from the Catalog.

This method might be useful if catalog-specific object instances should be directly forwarded from the catalog to a factory.

Specified by:

getOrigin in interface ResolvedCatalogBaseTable<CatalogMaterializedTable>

getResolvedSchema

public ResolvedSchema getResolvedSchema()

Description copied from interface: ResolvedCatalogBaseTable

Returns a fully resolved and validated ResolvedSchema.

Connectors can configure themselves by accessing ResolvedSchema.getPrimaryKey() and ResolvedSchema.toPhysicalRowDataType().

Specified by:

getResolvedSchema in interface ResolvedCatalogBaseTable<CatalogMaterializedTable>

getDefinitionQuery

public String getDefinitionQuery()

Description copied from interface: CatalogMaterializedTable

The definition query text of materialized table, text is expanded in contrast to the original SQL. This is needed because the context such as current DB is lost after the session, in which view is defined, is gone. Expanded query text takes care of this, as an example.

For example, for a materialized table that is defined in the context of "default" database with a query select * from test1, the expanded query text might become select `test1`.`name`, `test1`.`value` from `default`.`test1`, where table test1 resides in database "default" and has two columns ("name" and "value").

Specified by:

getDefinitionQuery in interface CatalogMaterializedTable

Returns:

the materialized table definition in expanded text.

getDefinitionFreshness

public IntervalFreshness getDefinitionFreshness()

Description copied from interface: CatalogMaterializedTable

Get the definition freshness of materialized table which is used to determine the physical refresh mode.

Specified by:

getDefinitionFreshness in interface CatalogMaterializedTable

getLogicalRefreshMode

public CatalogMaterializedTable.LogicalRefreshMode getLogicalRefreshMode()

Description copied from interface: CatalogMaterializedTable

Get the logical refresh mode of materialized table.

Specified by:

getLogicalRefreshMode in interface CatalogMaterializedTable

getRefreshMode

public CatalogMaterializedTable.RefreshMode getRefreshMode()

Description copied from interface: CatalogMaterializedTable

Get the physical refresh mode of materialized table.

Specified by:

getRefreshMode in interface CatalogMaterializedTable

getRefreshStatus

public CatalogMaterializedTable.RefreshStatus getRefreshStatus()

Description copied from interface: CatalogMaterializedTable

Get the refresh status of materialized table.

Specified by:

getRefreshStatus in interface CatalogMaterializedTable

getRefreshHandlerDescription

public Optional<String> getRefreshHandlerDescription()

Description copied from interface: CatalogMaterializedTable

Return summary description of refresh handler.

Specified by:

getRefreshHandlerDescription in interface CatalogMaterializedTable

getSerializedRefreshHandler

@Nullable
public byte[] getSerializedRefreshHandler()

Description copied from interface: CatalogMaterializedTable

Return the serialized refresh handler of materialized table. This will not be used for describe table.

Specified by:

getSerializedRefreshHandler in interface CatalogMaterializedTable

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

toResolvedCatalogTable

public ResolvedCatalogTable toResolvedCatalogTable()

Convert this object to a ResolvedCatalogTable object for planner optimize query.