org.apache.flink.table.factories

Interface DecodingFormatFactory<I>

Type Parameters:

I - runtime interface needed by the table source

All Superinterfaces:

Factory, FormatFactory

All Known Subinterfaces:

BulkReaderFormatFactory, DeserializationFormatFactory

All Known Implementing Classes:

AvroFileFormatFactory, AvroFormatFactory, CanalJsonFormatFactory, ChangelogCsvFormatFactory, CsvFileFormatFactory, CsvFormatFactory, DebeziumAvroFormatFactory, DebeziumJsonFormatFactory, JsonFormatFactory, MaxwellJsonFormatFactory, OggJsonFormatFactory, OrcFileFormatFactory, ParquetFileFormatFactory, PbFileFormatFactory, PbFormatFactory, RawFormatFactory, RegistryAvroFormatFactory

@PublicEvolving
public interface DecodingFormatFactory<I>
extends FormatFactory

Base interface for configuring a DecodingFormat for ScanTableSource and LookupTableSource.

Depending on the kind of external system, a connector might support different encodings for reading and writing rows. This interface helps in making such formats pluggable.

The created Format instance is an intermediate representation that can be used to construct runtime implementation in a later step.

See Also:

FactoryUtil.createTableFactoryHelper(DynamicTableFactory, DynamicTableFactory.Context)

Method Summary

Modifier and Type	Method and Description
DecodingFormat<I>	createDecodingFormat(DynamicTableFactory.Context context, ReadableConfig formatOptions) Creates a format from the given context and format options.

Methods inherited from interface org.apache.flink.table.factories.FormatFactory

forwardOptions

Methods inherited from interface org.apache.flink.table.factories.Factory

factoryIdentifier, optionalOptions, requiredOptions

Method Detail

createDecodingFormat

DecodingFormat<I> createDecodingFormat(DynamicTableFactory.Context context,
                                       ReadableConfig formatOptions)

Creates a format from the given context and format options.

The format options have been projected to top-level options (e.g. from format.ignore-errors to ignore-errors).