org.apache.flink.table.descriptors

Class ConnectTableDescriptor

java.lang.Object

org.apache.flink.table.descriptors.DescriptorBase

org.apache.flink.table.descriptors.TableDescriptor<ConnectTableDescriptor>

org.apache.flink.table.descriptors.ConnectTableDescriptor

All Implemented Interfaces:

org.apache.flink.table.descriptors.Descriptor

Direct Known Subclasses:

BatchTableDescriptor, StreamTableDescriptor

@PublicEvolving
public abstract class ConnectTableDescriptor
extends org.apache.flink.table.descriptors.TableDescriptor<ConnectTableDescriptor>

Describes a table connected from TableEnvironment.connect(ConnectorDescriptor).

It can access TableEnvironment for fluently registering the table.

Constructor Summary

Constructors

Constructor and Description
ConnectTableDescriptor(Registration registration, org.apache.flink.table.descriptors.ConnectorDescriptor connectorDescriptor)

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	additionalProperties()
void	createTemporaryTable(String path) Registers the table described by underlying properties in a given path.
void	registerTableSink(String name) Deprecated. use createTemporaryTable(String)
void	registerTableSource(String name) Deprecated. use createTemporaryTable(String)
void	registerTableSourceAndSink(String name) Deprecated. use createTemporaryTable(String)
ConnectTableDescriptor	withSchema(org.apache.flink.table.descriptors.Schema schema) Specifies the resulting table schema.

Methods inherited from class org.apache.flink.table.descriptors.TableDescriptor

inAppendMode, inRetractMode, inUpsertMode, toProperties, withFormat

Methods inherited from class org.apache.flink.table.descriptors.DescriptorBase

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectTableDescriptor

public ConnectTableDescriptor(Registration registration,
                              org.apache.flink.table.descriptors.ConnectorDescriptor connectorDescriptor)

Method Detail

withSchema

public ConnectTableDescriptor withSchema(org.apache.flink.table.descriptors.Schema schema)

Specifies the resulting table schema.

registerTableSource

@Deprecated
public void registerTableSource(String name)

Deprecated. use createTemporaryTable(String)

Searches for the specified table source, configures it accordingly, and registers it as a table under the given name.

Temporary objects can shadow permanent ones. If a permanent object in a given path exists, it will be inaccessible in the current session. To make the permanent object available again you can drop the corresponding temporary object.

Parameters:

name - table name to be registered in the table environment

registerTableSink

@Deprecated
public void registerTableSink(String name)

Deprecated. use createTemporaryTable(String)

Searches for the specified table sink, configures it accordingly, and registers it as a table under the given name.

Temporary objects can shadow permanent ones. If a permanent object in a given path exists, it will be inaccessible in the current session. To make the permanent object available again you can drop the corresponding temporary object.

Parameters:

name - table name to be registered in the table environment

registerTableSourceAndSink

@Deprecated
public void registerTableSourceAndSink(String name)

Deprecated. use createTemporaryTable(String)

Searches for the specified table source and sink, configures them accordingly, and registers them as a table under the given name.

Temporary objects can shadow permanent ones. If a permanent object in a given path exists, it will be inaccessible in the current session. To make the permanent object available again you can drop the corresponding temporary object.

Parameters:

name - table name to be registered in the table environment

createTemporaryTable

public void createTemporaryTable(String path)

Registers the table described by underlying properties in a given path.

There is no distinction between source and sink at the descriptor level anymore as this method does not perform actual class lookup. It only stores the underlying properties. The actual source/sink lookup is performed when the table is used.

Temporary objects can shadow permanent ones. If a permanent object in a given path exists, it will be inaccessible in the current session. To make the permanent object available again you can drop the corresponding temporary object.

NOTE: The schema must be explicitly defined.

Parameters:

path - path where to register the temporary table

additionalProperties

protected Map<String,String> additionalProperties()

Overrides:

additionalProperties in class org.apache.flink.table.descriptors.TableDescriptor<ConnectTableDescriptor>