org.apache.flink.table.planner.delegation

Class BlinkPlannerFactory

java.lang.Object

org.apache.flink.table.planner.delegation.BlinkPlannerFactory

All Implemented Interfaces:

PlannerFactory, ComponentFactory, TableFactory

@Internal
public final class BlinkPlannerFactory
extends Object
implements PlannerFactory

Factory to construct a BatchPlanner or StreamPlanner.

Constructor Summary

Constructors

Constructor and Description
BlinkPlannerFactory()

Method Summary

Modifier and Type	Method and Description
Planner	create(Map<String,String> properties, Executor executor, TableConfig tableConfig, FunctionCatalog functionCatalog, CatalogManager catalogManager) Creates a corresponding Planner.
Map<String,String>	optionalContext() Specifies a context of optional parameters that if exist should have the given values.
Map<String,String>	requiredContext() Specifies the context that this factory has been implemented for.
List<String>	supportedProperties() List of property keys that this factory can handle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlinkPlannerFactory

public BlinkPlannerFactory()

Method Detail

create

public Planner create(Map<String,String> properties,
                      Executor executor,
                      TableConfig tableConfig,
                      FunctionCatalog functionCatalog,
                      CatalogManager catalogManager)

Description copied from interface: PlannerFactory

Creates a corresponding Planner.

Specified by:

create in interface PlannerFactory

Parameters:

properties - Static properties of the Planner, the same that were used for factory lookup.

executor - The executor required by the planner.

tableConfig - The configuration of the planner to use.

functionCatalog - The function catalog to look up user defined functions.

catalogManager - The catalog manager to look up tables and views.

Returns:

instance of a Planner

optionalContext

public Map<String,String> optionalContext()

Description copied from interface: ComponentFactory

Specifies a context of optional parameters that if exist should have the given values. This enables further disambiguating if there are multiple factories that meet the ComponentFactory.requiredContext() and ComponentFactory.supportedProperties().

NOTE: All the property keys should be included in ComponentFactory.supportedProperties().

Specified by:

optionalContext in interface ComponentFactory

Returns:

optional properties to disambiguate factories

requiredContext

public Map<String,String> requiredContext()

Description copied from interface: TableFactory

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.

Specified by:

requiredContext in interface ComponentFactory

Specified by:

requiredContext in interface TableFactory

supportedProperties

public List<String> supportedProperties()

Description copied from interface: ComponentFactory

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.

NOTE: All the property keys from ComponentFactory.optionalContext() should also be included.

Specified by:

supportedProperties in interface ComponentFactory

Specified by:

supportedProperties in interface TableFactory