Package org.apache.flink.table.factories

Class FactoryUtil.TableFactoryHelper

java.lang.Object

org.apache.flink.table.factories.FactoryUtil.FactoryHelper<org.apache.flink.table.factories.DynamicTableFactory>

org.apache.flink.table.factories.FactoryUtil.TableFactoryHelper

Enclosing class:

FactoryUtil

@PublicEvolving
public static class FactoryUtil.TableFactoryHelper
extends FactoryUtil.FactoryHelper<org.apache.flink.table.factories.DynamicTableFactory>

Helper utility for discovering formats and validating all options for a DynamicTableFactory.

See Also:

• FactoryUtil.createTableFactoryHelper(DynamicTableFactory, DynamicTableFactory.Context)

Field Summary

Fields inherited from class org.apache.flink.table.factories.FactoryUtil.FactoryHelper

allOptions, consumedOptionKeys, deprecatedOptionKeys, factory

Method Summary

Modifier and Type	Method	Description
<I, F extends org.apache.flink.table.factories.DecodingFormatFactory<I>> org.apache.flink.table.connector.format.DecodingFormat<I>	discoverDecodingFormat(Class<F> formatFactoryClass, ConfigOption<String> formatOption)	Discovers a DecodingFormat of the given type using the given option as factory identifier.
<I, F extends org.apache.flink.table.factories.EncodingFormatFactory<I>> org.apache.flink.table.connector.format.EncodingFormat<I>	discoverEncodingFormat(Class<F> formatFactoryClass, ConfigOption<String> formatOption)	Discovers a EncodingFormat of the given type using the given option as factory identifier.
<I, F extends org.apache.flink.table.factories.DecodingFormatFactory<I>> Optional<org.apache.flink.table.connector.format.DecodingFormat<I>>	discoverOptionalDecodingFormat(Class<F> formatFactoryClass, ConfigOption<String> formatOption)	Discovers a DecodingFormat of the given type using the given option (if present) as factory identifier.
<I, F extends org.apache.flink.table.factories.EncodingFormatFactory<I>> Optional<org.apache.flink.table.connector.format.EncodingFormat<I>>	discoverOptionalEncodingFormat(Class<F> formatFactoryClass, ConfigOption<String> formatOption)	Discovers a EncodingFormat of the given type using the given option (if present) as factory identifier.
ReadableConfig	getOptions()	Returns all options currently being consumed by the factory.

Methods inherited from class org.apache.flink.table.factories.FactoryUtil.FactoryHelper

validate, validateExcept

Methods inherited from class java.lang.Object

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

Method Details

getOptions

public ReadableConfig getOptions()

Returns all options currently being consumed by the factory. This method returns the options already merged with DynamicTableFactory.Context.getEnrichmentOptions(), using DynamicTableFactory.forwardOptions() as reference of mergeable options.

Overrides:

getOptions in class FactoryUtil.FactoryHelper<org.apache.flink.table.factories.DynamicTableFactory>

discoverDecodingFormat

public <I,
F extends org.apache.flink.table.factories.DecodingFormatFactory<I>>
org.apache.flink.table.connector.format.DecodingFormat<I> discoverDecodingFormat(Class<F> formatFactoryClass,
 ConfigOption<String> formatOption)

Discovers a DecodingFormat of the given type using the given option as factory identifier.

discoverOptionalDecodingFormat

public <I,
F extends org.apache.flink.table.factories.DecodingFormatFactory<I>>
Optional<org.apache.flink.table.connector.format.DecodingFormat<I>> discoverOptionalDecodingFormat(Class<F> formatFactoryClass,
 ConfigOption<String> formatOption)

Discovers a DecodingFormat of the given type using the given option (if present) as factory identifier.

discoverEncodingFormat

public <I,
F extends org.apache.flink.table.factories.EncodingFormatFactory<I>>
org.apache.flink.table.connector.format.EncodingFormat<I> discoverEncodingFormat(Class<F> formatFactoryClass,
 ConfigOption<String> formatOption)

Discovers a EncodingFormat of the given type using the given option as factory identifier.

discoverOptionalEncodingFormat

public <I,
F extends org.apache.flink.table.factories.EncodingFormatFactory<I>>
Optional<org.apache.flink.table.connector.format.EncodingFormat<I>> discoverOptionalEncodingFormat(Class<F> formatFactoryClass,
 ConfigOption<String> formatOption)

Discovers a EncodingFormat of the given type using the given option (if present) as factory identifier.