org.apache.flink.table.catalog

Class CatalogTableBuilder

java.lang.Object

org.apache.flink.table.descriptors.DescriptorBase

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

org.apache.flink.table.catalog.CatalogTableBuilder

All Implemented Interfaces:

org.apache.flink.table.descriptors.Descriptor

@PublicEvolving
public final class CatalogTableBuilder
extends org.apache.flink.table.descriptors.TableDescriptor<CatalogTableBuilder>

A builder for creating a CatalogTable.

It takes Descriptors which allow for declaring the communication to external systems in an implementation-agnostic way. The classpath is scanned for suitable table factories that match the desired configuration.

Use the provided builder methods to configure the catalog table accordingly.

The following example shows how to read from a connector using a JSON format and declaring it as a table source: CatalogTable table = new CatalogTableBuilder( new ExternalSystemXYZ() .version("0.11"), new TableSchema.Builder() .fields(names, dataTypes) .build()) .withFormat( new Json() .jsonSchema("{...}") .failOnMissingField(false)) .withComment("test comment") .build()

Constructor Summary

Constructors

Constructor and Description
CatalogTableBuilder(org.apache.flink.table.descriptors.ConnectorDescriptor connectorDescriptor, org.apache.flink.table.api.TableSchema tableSchema)

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	additionalProperties()
org.apache.flink.table.catalog.CatalogTable	build() Builds a CatalogTable.
CatalogTableBuilder	withComment(String comment)
CatalogTableBuilder	withPartitionKeys(List<String> partitionKeys)
CatalogTableBuilder	withProperties(Map<String,String> properties)

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

CatalogTableBuilder

public CatalogTableBuilder(org.apache.flink.table.descriptors.ConnectorDescriptor connectorDescriptor,
                           org.apache.flink.table.api.TableSchema tableSchema)

Method Detail

withComment

public CatalogTableBuilder withComment(String comment)

withProperties

public CatalogTableBuilder withProperties(Map<String,String> properties)

withPartitionKeys

public CatalogTableBuilder withPartitionKeys(List<String> partitionKeys)

build

public org.apache.flink.table.catalog.CatalogTable build()

Builds a CatalogTable.

additionalProperties

protected Map<String,String> additionalProperties()

Overrides:

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