org.apache.flink.table.catalog

Class ResolvedCatalogView

java.lang.Object

org.apache.flink.table.catalog.ResolvedCatalogView

All Implemented Interfaces:

CatalogBaseTable, CatalogView, ResolvedCatalogBaseTable<CatalogView>

@PublicEvolving
public final class ResolvedCatalogView
extends Object
implements ResolvedCatalogBaseTable<CatalogView>, CatalogView

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

Nested Class Summary

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

CatalogBaseTable.TableKind

Constructor Summary

Constructors

Constructor and Description
ResolvedCatalogView(CatalogView origin, ResolvedSchema resolvedSchema)

Method Summary

Modifier and Type	Method and 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.
String	getExpandedQuery() Expanded text of the original view definition This is needed because the context such as current DB is lost after the session, in which view is defined, is gone.
Map<String,String>	getOptions() Returns a map of string-based options.
CatalogView	getOrigin() Returns the original, unresolved metadata object from the Catalog.
String	getOriginalQuery() Original text of the view definition that also preserves the original formatting.
ResolvedSchema	getResolvedSchema() Returns a fully resolved and validated ResolvedSchema.
Schema	getUnresolvedSchema() Returns the schema of the table or view.

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

getSchema

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

getTableKind, of

Constructor Detail

ResolvedCatalogView

public ResolvedCatalogView(CatalogView origin,
                           ResolvedSchema resolvedSchema)

Method Detail

getOrigin

public CatalogView 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<CatalogView>

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<CatalogView>

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

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.

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

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

getOriginalQuery

public String getOriginalQuery()

Description copied from interface: CatalogView

Original text of the view definition that also preserves the original formatting.

Specified by:

getOriginalQuery in interface CatalogView

Returns:

the original string literal provided by the user.

getExpandedQuery

public String getExpandedQuery()

Description copied from interface: CatalogView

Expanded text of the original view definition 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 view 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:

getExpandedQuery in interface CatalogView

Returns:

the view definition in expanded text.