Package io.confluent.flink.plugin

Class ConfluentTableDescriptor.Builder

java.lang.Object

org.apache.flink.table.api.TableDescriptor.Builder

io.confluent.flink.plugin.ConfluentTableDescriptor.Builder

Enclosing class:

ConfluentTableDescriptor

public static class ConfluentTableDescriptor.Builder
extends TableDescriptor.Builder

Builder for ConfluentTableDescriptor.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(ConfluentTableDescriptor descriptor)

Method Summary

Modifier and Type	Method	Description
ConfluentTableDescriptor	build()	Creates an instance of ConfluentTableDescriptor.
ConfluentTableDescriptor.Builder	comment(String comment)	Define the comment for this table.
ConfluentTableDescriptor.Builder	distributedBy(int numberOfBuckets, String... bucketKeys)	Defines that the table should be distributed into the given number of buckets by the given columns.
ConfluentTableDescriptor.Builder	distributedBy(String... bucketKeys)	Defines that the table should be distributed into buckets over the given columns.
ConfluentTableDescriptor.Builder	distributedByHash(int numberOfBuckets, String... bucketKeys)	Defines that the table should be distributed into the given number of buckets using a hash algorithm over the given columns.
ConfluentTableDescriptor.Builder	distributedByHash(String... bucketKeys)	Defines that the table should be distributed into buckets using a hash algorithm over the given columns.
ConfluentTableDescriptor.Builder	distributedByRange(int numberOfBuckets, String... bucketKeys)	Defines that the table should be distributed into the given number of buckets using a range algorithm over the given columns.
ConfluentTableDescriptor.Builder	distributedByRange(String... bucketKeys)	Defines that the table should be distributed into buckets using a range algorithm over the given columns.
ConfluentTableDescriptor.Builder	distributedInto(int numberOfBuckets)	Defines that the table should be distributed into the given number of buckets.
ConfluentTableDescriptor.Builder	format(String format)	Defines the format to be used for this table.
ConfluentTableDescriptor.Builder	format(ConfigOption<String> formatOption, FormatDescriptor formatDescriptor)	Defines the format to be used for this table.
ConfluentTableDescriptor.Builder	format(FormatDescriptor formatDescriptor)	Defines the format to be used for this table.
ConfluentTableDescriptor.Builder	keyFormat(FormatDescriptor formatDescriptor)	Defines the key format for Kafka-based tables.
ConfluentTableDescriptor.Builder	option(String key, String value)	Sets the given option on the table.
<T> ConfluentTableDescriptor.Builder	option(ConfigOption<T> configOption, T value)	Sets the given option on the table.
ConfluentTableDescriptor.Builder	partitionedBy(String... partitionKeys)	Define which columns this table is partitioned by.
ConfluentTableDescriptor.Builder	schema(Schema schema)	Define the schema of the TableDescriptor.
ConfluentTableDescriptor.Builder	valueFormat(FormatDescriptor formatDescriptor)	Defines the value format for Kafka-based tables.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Builder

protected Builder(ConfluentTableDescriptor descriptor)

Method Details

schema

public ConfluentTableDescriptor.Builder schema(@Nullable
 Schema schema)

Define the schema of the TableDescriptor.

The schema is typically required. It is optional only in cases where the schema can be inferred, e.g. Table.insertInto(TableDescriptor).

Overrides:

schema in class TableDescriptor.Builder

option

public <T> ConfluentTableDescriptor.Builder option(ConfigOption<T> configOption,
 T value)

Sets the given option on the table.

Overrides:

option in class TableDescriptor.Builder

option

public ConfluentTableDescriptor.Builder option(String key,
 String value)

Sets the given option on the table.

Option keys must be fully specified. When defining options for a format, use TableDescriptor.Builder.format(FormatDescriptor) instead.

Example:

 TableDescriptor.forConnector("kafka")
   .option("scan.startup.mode", "latest-offset")
   .build();
 

Overrides:

option in class TableDescriptor.Builder

format

public ConfluentTableDescriptor.Builder format(String format)

Defines the format to be used for this table.

Note that not every connector requires a format to be specified, while others may use multiple formats. In the latter case, use TableDescriptor.Builder.format(ConfigOption, FormatDescriptor) instead to specify for which option the format should be configured.

Overrides:

format in class TableDescriptor.Builder

format

public ConfluentTableDescriptor.Builder format(FormatDescriptor formatDescriptor)

Defines the format to be used for this table.

Note that not every connector requires a format to be specified, while others may use multiple formats.

Options of the provided are automatically prefixed. For example,

 descriptorBuilder.format(FormatDescriptor.forFormat("json")
   .option(JsonOptions.IGNORE_PARSE_ERRORS, true)
   .build()
 

will result in the options

 'format' = 'json'
 'json.ignore-parse-errors' = 'true'
 

Overrides:

format in class TableDescriptor.Builder

format

public ConfluentTableDescriptor.Builder format(ConfigOption<String> formatOption,
 FormatDescriptor formatDescriptor)

Defines the format to be used for this table.

Note that not every connector requires a format to be specified, while others may use multiple formats.

Options of the provided are automatically prefixed. For example,

 descriptorBuilder.format(KafkaOptions.KEY_FORMAT, FormatDescriptor.forFormat("json")
   .option(JsonOptions.IGNORE_PARSE_ERRORS, true)
   .build()
 

will result in the options

 'key.format' = 'json'
 'key.json.ignore-parse-errors' = 'true'
 

Overrides:

format in class TableDescriptor.Builder

distributedByHash

public ConfluentTableDescriptor.Builder distributedByHash(String... bucketKeys)

Defines that the table should be distributed into buckets using a hash algorithm over the given columns. The number of buckets is connector-defined.

Overrides:

distributedByHash in class TableDescriptor.Builder

distributedByHash

public ConfluentTableDescriptor.Builder distributedByHash(int numberOfBuckets,
 String... bucketKeys)

Defines that the table should be distributed into the given number of buckets using a hash algorithm over the given columns.

Overrides:

distributedByHash in class TableDescriptor.Builder

distributedByRange

public ConfluentTableDescriptor.Builder distributedByRange(String... bucketKeys)

Defines that the table should be distributed into buckets using a range algorithm over the given columns. The number of buckets is connector-defined.

Overrides:

distributedByRange in class TableDescriptor.Builder

distributedByRange

public ConfluentTableDescriptor.Builder distributedByRange(int numberOfBuckets,
 String... bucketKeys)

Defines that the table should be distributed into the given number of buckets using a range algorithm over the given columns.

Overrides:

distributedByRange in class TableDescriptor.Builder

distributedBy

public ConfluentTableDescriptor.Builder distributedBy(String... bucketKeys)

Defines that the table should be distributed into buckets over the given columns. The number of buckets and used algorithm are connector-defined.

Overrides:

distributedBy in class TableDescriptor.Builder

distributedBy

public ConfluentTableDescriptor.Builder distributedBy(int numberOfBuckets,
 String... bucketKeys)

Defines that the table should be distributed into the given number of buckets by the given columns. The used algorithm is connector-defined.

Overrides:

distributedBy in class TableDescriptor.Builder

distributedInto

public ConfluentTableDescriptor.Builder distributedInto(int numberOfBuckets)

Defines that the table should be distributed into the given number of buckets. The algorithm is connector-defined.

Overrides:

distributedInto in class TableDescriptor.Builder

partitionedBy

public ConfluentTableDescriptor.Builder partitionedBy(String... partitionKeys)

Define which columns this table is partitioned by.

Overrides:

partitionedBy in class TableDescriptor.Builder

comment

public ConfluentTableDescriptor.Builder comment(@Nullable
 String comment)

Define the comment for this table.

Overrides:

comment in class TableDescriptor.Builder

keyFormat

public ConfluentTableDescriptor.Builder keyFormat(FormatDescriptor formatDescriptor)

Defines the key format for Kafka-based tables.

Options of the provided are automatically prefixed. For example,

 descriptorBuilder.keyFormat(
   FormatDescriptor.forFormat("json")
     .option("validate-writes", "true")
     .build()
 )
 

will result in the options

 'key.format' = 'json'
 'key.json.validate-writes' = 'true'
 

Options that affect which columns belong to the format, can be set with option(String, String), for example .option("key.fields-prefix", "k_").

valueFormat

public ConfluentTableDescriptor.Builder valueFormat(FormatDescriptor formatDescriptor)

Defines the value format for Kafka-based tables.

Options of the provided are automatically prefixed. For example,

 descriptorBuilder.valueFormat(
   FormatDescriptor.forFormat("json")
     .option("validate-writes", "true")
     .build()
 )
 

will result in the options

 'value.format' = 'json'
 'value.json.validate-writes' = 'true'
 

Options that affect which columns belong to the format, can be set with option(String, String), for example .option("value.fields-include", "all").

build

public ConfluentTableDescriptor build()

Creates an instance of ConfluentTableDescriptor.

Overrides:

build in class TableDescriptor.Builder