Package org.apache.flink.table.factories

Interface ModuleFactory

All Superinterfaces:
Factory
All Known Implementing Classes:
CoreModuleFactory
@PublicEvolving public interface ModuleFactory extends Factory
A factory to create configured module instances based on string-based properties. See also Factory for more information.

Note that this interface supports the TableFactory stack for compatibility purposes. This is deprecated, however, and new implementations should implement the Factory stack instead.

  • Method Details

    • createModule

      default Module createModule(ModuleFactory.Context context)
      Creates and configures a Module.

    • factoryIdentifier

      String factoryIdentifier()
      Description copied from interface: Factory
      Returns a unique identifier among same factory interfaces.

      For consistency, an identifier should be declared as one lower case word (e.g. kafka). If multiple factories exist for different versions, a version should be appended using "-" (e.g. elasticsearch-7).

      Specified by:
      factoryIdentifier in interface Factory

    • requiredOptions

      Set<org.apache.flink.configuration.ConfigOption<?>> requiredOptions()
      Description copied from interface: Factory
      Returns a set of ConfigOption that an implementation of this factory requires in addition to Factory.optionalOptions().

      See the documentation of Factory for more information.

      Specified by:
      requiredOptions in interface Factory

    • optionalOptions

      Set<org.apache.flink.configuration.ConfigOption<?>> optionalOptions()
      Description copied from interface: Factory
      Returns a set of ConfigOption that an implementation of this factory consumes in addition to Factory.requiredOptions().

      See the documentation of Factory for more information.

      Specified by:
      optionalOptions in interface Factory