org.apache.flink.table.factories

Class FactoryUtil

java.lang.Object

org.apache.flink.table.factories.FactoryUtil

@PublicEvolving
public final class FactoryUtil
extends Object

Utility for working with Factorys.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FactoryUtil.TableFactoryHelper 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>	CONNECTOR
static org.apache.flink.configuration.ConfigOption<String>	FORMAT
static org.apache.flink.configuration.ConfigOption<String>	KEY_FORMAT
static org.apache.flink.configuration.ConfigOption<Integer>	PROPERTY_VERSION
static org.apache.flink.configuration.ConfigOption<String>	VALUE_FORMAT

Method Summary

Modifier and Type	Method and Description
static FactoryUtil.TableFactoryHelper	createTableFactoryHelper(DynamicTableFactory factory, DynamicTableFactory.Context context) Creates a utility that helps in discovering formats and validating all options for a DynamicTableFactory.
static DynamicTableSink	createTableSink(Catalog catalog, ObjectIdentifier objectIdentifier, CatalogTable catalogTable, org.apache.flink.configuration.ReadableConfig configuration, ClassLoader classLoader) Creates a DynamicTableSink from a CatalogTable.
static DynamicTableSource	createTableSource(Catalog catalog, ObjectIdentifier objectIdentifier, CatalogTable catalogTable, org.apache.flink.configuration.ReadableConfig configuration, ClassLoader classLoader) Creates a DynamicTableSource from a CatalogTable.
static <T extends Factory> T	discoverFactory(ClassLoader classLoader, Class<T> factoryClass, String factoryIdentifier) Discovers a factory using the given factory base class and identifier.
static void	validateFactoryOptions(Factory factory, org.apache.flink.configuration.ReadableConfig options) Validates the required and optional ConfigOptions of a factory.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_VERSION

public static final org.apache.flink.configuration.ConfigOption<Integer> PROPERTY_VERSION

CONNECTOR

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

KEY_FORMAT

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

VALUE_FORMAT

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

FORMAT

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

Method Detail

createTableSource

public static DynamicTableSource createTableSource(@Nullable
                                                   Catalog catalog,
                                                   ObjectIdentifier objectIdentifier,
                                                   CatalogTable catalogTable,
                                                   org.apache.flink.configuration.ReadableConfig configuration,
                                                   ClassLoader classLoader)

Creates a DynamicTableSource from a CatalogTable.

It considers Catalog.getFactory() if provided.

createTableSink

public static DynamicTableSink createTableSink(@Nullable
                                               Catalog catalog,
                                               ObjectIdentifier objectIdentifier,
                                               CatalogTable catalogTable,
                                               org.apache.flink.configuration.ReadableConfig configuration,
                                               ClassLoader classLoader)

Creates a DynamicTableSink from a CatalogTable.

It considers Catalog.getFactory() if provided.

createTableFactoryHelper

public static FactoryUtil.TableFactoryHelper createTableFactoryHelper(DynamicTableFactory factory,
                                                                      DynamicTableFactory.Context context)

Creates a utility that helps in discovering formats and validating all options for a DynamicTableFactory.

The following example sketches the usage:

 // in createDynamicTableSource()
 helper = FactoryUtil.createTableFactoryHelper(this, context);
 keyFormat = helper.discoverScanFormat(DeserializationFormatFactory.class, KEY_FORMAT);
 valueFormat = helper.discoverScanFormat(DeserializationFormatFactory.class, VALUE_FORMAT);
 helper.validate();
 ... // construct connector with discovered formats
 

Note: The format option parameter of helper.discoverScanFormat(formatFactoryClass, formatOption) and helper.discoverSinkFormat(formatFactoryClass, formatOption) must be 'format' or with '.format' suffix (e.g. FORMAT, KEY_FORMAT and VALUE_FORMAT). The discovery logic will replace 'format' with the factory identifier value as the format prefix. For example, assuming the identifier is 'json', if format option key is 'format', then format prefix is 'json.'. If format option key is 'value.format', then format prefix is 'value.json'. The format prefix is used to project the options for the format factory.

Note: This utility checks for left-over options in the final step.

discoverFactory

public static <T extends Factory> T discoverFactory(ClassLoader classLoader,
                                                    Class<T> factoryClass,
                                                    String factoryIdentifier)

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

This method is meant for cases where createTableFactoryHelper(DynamicTableFactory, DynamicTableFactory.Context) createTableSource(Catalog, ObjectIdentifier, CatalogTable, ReadableConfig, ClassLoader), and createTableSink(Catalog, ObjectIdentifier, CatalogTable, ReadableConfig, ClassLoader) are not applicable.

validateFactoryOptions

public static void validateFactoryOptions(Factory factory,
                                          org.apache.flink.configuration.ReadableConfig options)

Validates the required and optional ConfigOptions of a factory.

Note: It does not check for left-over options.