Package io.confluent.flink.plugin

Class ConfluentTableDescriptor

java.lang.Object

org.apache.flink.table.api.TableDescriptor

io.confluent.flink.plugin.ConfluentTableDescriptor

public final class ConfluentTableDescriptor
extends TableDescriptor

A TableDescriptor for creating tables located in Confluent Cloud programmatically.

Compared to TableDescriptor, this class adds support for Confluent's system columns and convenience methods for working with Confluent tables.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfluentTableDescriptor.Builder	Builder for ConfluentTableDescriptor.

Method Summary

Modifier and Type	Method	Description
static ConfluentTableDescriptor.Builder	forConnector(String connectorIdentifier)	Creates a TableDescriptor for a table in Confluent Cloud.
static ConfluentTableDescriptor.Builder	forManaged()	Creates a TableDescriptor for a Confluent-managed table.
ConfluentTableDescriptor.Builder	toBuilder()	Converts this immutable instance into a mutable TableDescriptor.Builder.

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

equals, getComment, getDistribution, getOptions, getPartitionKeys, getSchema, hashCode, toCatalogTable, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

forManaged

public static ConfluentTableDescriptor.Builder forManaged()

Creates a TableDescriptor for a Confluent-managed table.

The descriptor is pre-configured with 'connector' = 'confluent'. Use the returned ConfluentTableDescriptor.Builder to further customize the table.

forConnector

public static ConfluentTableDescriptor.Builder forConnector(String connectorIdentifier)

Creates a TableDescriptor for a table in Confluent Cloud.

The descriptor is pre-configured with given 'connector'. Use the returned ConfluentTableDescriptor.Builder to further customize the table.

toBuilder

public ConfluentTableDescriptor.Builder toBuilder()

Description copied from class: TableDescriptor

Converts this immutable instance into a mutable TableDescriptor.Builder.

Overrides:

toBuilder in class TableDescriptor