org.apache.paimon.flink.factories

Class FlinkFactoryUtil

java.lang.Object

org.apache.paimon.flink.factories.FlinkFactoryUtil

public final class FlinkFactoryUtil
extends Object

Utility for working with Factorys.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlinkFactoryUtil.FlinkFactoryHelper<F extends LogStoreTableFactory> Base flink helper utility for validating all options for a LogStoreTableFactory.
static class	FlinkFactoryUtil.FlinkTableFactoryHelper Helper utility for discovering formats and validating all options for a DynamicTableFactory.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.flink.configuration.ConfigOption<String>	FORMAT
static String	FORMAT_SUFFIX Suffix for keys of ConfigOption in case a connector requires multiple formats (e.g.

Method Summary

Modifier and Type	Method and Description
static FlinkFactoryUtil.FlinkTableFactoryHelper	createFlinkTableFactoryHelper(LogStoreTableFactory factory, org.apache.flink.table.factories.DynamicTableFactory.Context context) Creates a utility that helps in discovering formats, merging options with DynamicTableFactory.Context#getEnrichmentOptions() and validating them all for a LogStoreTableFactory.
static <T extends org.apache.flink.table.factories.Factory> T	discoverFlinkFactory(ClassLoader classLoader, Class<T> factoryClass, String factoryIdentifier) Discovers a flink Factory using the given factory base class and identifier.
static String	getFormatPrefix(org.apache.flink.configuration.ConfigOption<String> formatOption, String formatIdentifier) Returns the required option prefix for options of the given format.

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT

public static final org.apache.flink.configuration.ConfigOption<String> FORMAT

FORMAT_SUFFIX

public static final String FORMAT_SUFFIX

Suffix for keys of ConfigOption in case a connector requires multiple formats (e.g. for both key and value).

See #createFlinkTableFactoryHelper(LogStoreTableFactory, Context) Context)} for more information.

See Also:

Constant Field Values

Method Detail

createFlinkTableFactoryHelper

public static FlinkFactoryUtil.FlinkTableFactoryHelper createFlinkTableFactoryHelper(LogStoreTableFactory factory,
                                                                                     org.apache.flink.table.factories.DynamicTableFactory.Context context)

Creates a utility that helps in discovering formats, merging options with DynamicTableFactory.Context#getEnrichmentOptions() and validating them all for a LogStoreTableFactory.

The following example sketches the usage:

 // in createDynamicTableSource()
 helper = FlinkFactoryUtil.createFlinkTableFactoryHelper(this, context);

 keyFormat = helper.discoverDecodingFormat(DeserializationFormatFactory.class, KEY_FORMAT);
 valueFormat = helper.discoverDecodingFormat(DeserializationFormatFactory.class, VALUE_FORMAT);

 helper.validate();

 ... // construct connector with discovered formats
 

discoverFlinkFactory

public static <T extends org.apache.flink.table.factories.Factory> T discoverFlinkFactory(ClassLoader classLoader,
                                                                                          Class<T> factoryClass,
                                                                                          String factoryIdentifier)

Discovers a flink Factory using the given factory base class and identifier.

getFormatPrefix

public static String getFormatPrefix(org.apache.flink.configuration.ConfigOption<String> formatOption,
                                     String formatIdentifier)

Returns the required option prefix for options of the given format.