org.apache.flink.table.factories

Interface TableFactory

All Known Subinterfaces:

CatalogFactory, ModuleFactory, StreamTableSinkFactory<T>, StreamTableSourceFactory<T>, TableSinkFactory<T>, TableSourceFactory<T>

All Known Implementing Classes:

CoreModuleFactory, CsvAppendTableSinkFactory, CsvAppendTableSourceFactory, CsvBatchTableSinkFactory, CsvBatchTableSourceFactory, CsvTableSinkFactoryBase, CsvTableSourceFactoryBase, GenericInMemoryCatalogFactory, HiveCatalogFactory, HiveModuleFactory, HiveTableFactory, TestFileSystemCatalogFactory

Deprecated.

This interface has been replaced by Factory.

@Deprecated
 @PublicEvolving
public interface TableFactory

A factory to create different table-related instances from string-based properties. This factory is used with Java's Service Provider Interfaces (SPI) for discovering. A factory is called with a set of normalized properties that describe the desired configuration. The factory allows for matching to the given set of properties.

Classes that implement this interface can be added to the "META_INF/services/org.apache.flink.table.factories.TableFactory" file of a JAR file in the current classpath to be found.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	requiredContext() Deprecated. Specifies the context that this factory has been implemented for.
List<String>	supportedProperties() Deprecated. List of property keys that this factory can handle.

Method Detail

requiredContext

Map<String,String> requiredContext()

Deprecated.

Specifies the context that this factory has been implemented for. The framework guarantees to only match for this factory if the specified set of properties and values are met.

Typical properties might be: - connector.type - format.type

Specified property versions allow the framework to provide backwards compatible properties in case of string format changes: - connector.property-version - format.property-version

An empty context means that the factory matches for all requests.

supportedProperties

List<String> supportedProperties()

Deprecated.

List of property keys that this factory can handle. This method will be used for validation. If a property is passed that this factory cannot handle, an exception will be thrown. The list must not contain the keys that are specified by the context.

Example properties might be: - schema.#.type - schema.#.name - connector.topic - format.line-delimiter - format.ignore-parse-errors - format.fields.#.type - format.fields.#.name

Note: Use "#" to denote an array of values where "#" represents one or more digits. Property versions like "format.property-version" must not be part of the supported properties.

In some cases it might be useful to declare wildcards "*". Wildcards can only be declared at the end of a property key.

For example, if an arbitrary format should be supported: - format.*

Note: Wildcards should be used with caution as they might swallow unsupported properties and thus might lead to undesired behavior.