org.apache.flink.table.factories

Class FactoryUtil.DefaultDynamicTableContext

java.lang.Object

org.apache.flink.table.factories.FactoryUtil.DefaultDynamicTableContext

All Implemented Interfaces:

DynamicTableFactory.Context

Enclosing class:

FactoryUtil

@Internal
public static class FactoryUtil.DefaultDynamicTableContext
extends Object
implements DynamicTableFactory.Context

Default implementation of DynamicTableFactory.Context.

Constructor Summary

Constructors

Constructor and Description
DefaultDynamicTableContext(ObjectIdentifier objectIdentifier, ResolvedCatalogTable catalogTable, ReadableConfig configuration, ClassLoader classLoader, boolean isTemporary)

Method Summary

Modifier and Type	Method and Description
ResolvedCatalogTable	getCatalogTable() Returns the resolved table information received from the Catalog.
ClassLoader	getClassLoader() Returns the class loader of the current session.
ReadableConfig	getConfiguration() Gives read-only access to the configuration of the current session.
ObjectIdentifier	getObjectIdentifier() Returns the identifier of the table in the Catalog.
boolean	isTemporary() Whether the table is temporary.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDynamicTableContext

public DefaultDynamicTableContext(ObjectIdentifier objectIdentifier,
                                  ResolvedCatalogTable catalogTable,
                                  ReadableConfig configuration,
                                  ClassLoader classLoader,
                                  boolean isTemporary)

Method Detail

getObjectIdentifier

public ObjectIdentifier getObjectIdentifier()

Description copied from interface: DynamicTableFactory.Context

Returns the identifier of the table in the Catalog.

Specified by:

getObjectIdentifier in interface DynamicTableFactory.Context

getCatalogTable

public ResolvedCatalogTable getCatalogTable()

Description copied from interface: DynamicTableFactory.Context

Returns the resolved table information received from the Catalog.

The ResolvedCatalogTable forwards the metadata from the catalog but offers a validated ResolvedSchema. The original metadata object is available via ResolvedCatalogTable.getOrigin().

In most cases, a factory is interested in the following two characteristics:

 // get the physical data type to initialize the connector
 context.getCatalogTable().getResolvedSchema().toPhysicalRowDataType()

 // get primary key information if the connector supports upserts
 context.getCatalogTable().getResolvedSchema().getPrimaryKey()
 

Other characteristics such as metadata columns or watermarks will be pushed down into the created DynamicTableSource or DynamicTableSink during planning depending on the implemented ability interfaces.

Specified by:

getCatalogTable in interface DynamicTableFactory.Context

getConfiguration

public ReadableConfig getConfiguration()

Description copied from interface: DynamicTableFactory.Context

Gives read-only access to the configuration of the current session.

Specified by:

getConfiguration in interface DynamicTableFactory.Context

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: DynamicTableFactory.Context

Returns the class loader of the current session.

The class loader is in particular useful for discovering further (nested) factories.

Specified by:

getClassLoader in interface DynamicTableFactory.Context

isTemporary

public boolean isTemporary()

Description copied from interface: DynamicTableFactory.Context

Whether the table is temporary.

Specified by:

isTemporary in interface DynamicTableFactory.Context