Package org.apache.flink.table.factories

Interface FormatFactory

All Superinterfaces:
Factory
All Known Subinterfaces:
DecodingFormatFactory<I>, DeserializationFormatFactory, EncodingFormatFactory<I>, SerializationFormatFactory
@PublicEvolving public interface FormatFactory extends Factory
Base interface for DecodingFormatFactory and EncodingFormatFactory.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Set<org.apache.flink.configuration.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 Details

    • forwardOptions

      default Set<org.apache.flink.configuration.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: