FormatFactory (Flink : 2.0-SNAPSHOT API)

All Superinterfaces:

Factory

All Known Subinterfaces:

BulkReaderFormatFactory, BulkWriterFormatFactory, DecodingFormatFactory<I>, DeserializationFormatFactory, EncodingFormatFactory<I>, SerializationFormatFactory

All Known Implementing Classes:

AvroFileFormatFactory, AvroFormatFactory, CanalJsonFormatFactory, ChangelogCsvFormatFactory, CsvFileFormatFactory, CsvFormatFactory, DebeziumAvroFormatFactory, DebeziumJsonFormatFactory, JsonFormatFactory, MaxwellJsonFormatFactory, OggJsonFormatFactory, OrcFileFormatFactory, ParquetFileFormatFactory, PbFileFormatFactory, PbFormatFactory, RawFormatFactory, RegistryAvroFormatFactory
```
@PublicEvolving
public interface FormatFactory
extends Factory
```
Base interface for DecodingFormatFactory and EncodingFormatFactory.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default Set<ConfigOption<?>>`	`forwardOptions()`	Returns a set of `ConfigOption` that are directly forwarded to the runtime implementation but don't affect the final execution topology.

Methods inherited from interface org.apache.flink.table.factories.Factory
factoryIdentifier, optionalOptions, requiredOptions

- Method Detail
  - forwardOptions
```
default Set<ConfigOption<?>> forwardOptions()
```
    Returns a set of ConfigOption that are directly forwarded to the runtime implementation but don't affect the final execution topology.
    Options declared here can override options of the persisted plan during an enrichment phase. Since a restored topology is static, an implementer has to ensure that the declared options don't affect fundamental abilities such as ChangelogMode.
    For example, given a JSON format, if an option defines how to parse timestamps, changing the parsing behavior does not affect the pipeline topology and can be allowed. However, an option that defines whether the format results in a ProjectableDecodingFormat or not is not allowed. The wrapping connector and planner might not react to the changed abilities anymore.
    
    See Also:
    
    DynamicTableFactory.Context.getEnrichmentOptions()