org.apache.flink.table.executor

Class StreamExecutorFactory

java.lang.Object

org.apache.flink.table.executor.StreamExecutorFactory

All Implemented Interfaces:

ExecutorFactory, ComponentFactory, TableFactory

@Internal
public class StreamExecutorFactory
extends Object
implements ExecutorFactory

Factory to create an implementation of Executor to use in a TableEnvironment. The TableEnvironment should use create(Map) method that does not bind to any particular environment, whereas StreamTableEnvironment should use create(Map, StreamExecutionEnvironment) as it is always backed by some StreamExecutionEnvironment

Constructor Summary

Constructors

Constructor and Description
StreamExecutorFactory()

Method Summary

Modifier and Type	Method and Description
Executor	create(Map<String,String> properties) Creates a corresponding Executor.
Executor	create(Map<String,String> properties, StreamExecutionEnvironment executionEnvironment) Creates a corresponding StreamExecutor.
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

StreamExecutorFactory

public StreamExecutorFactory()

Method Detail

create

public Executor create(Map<String,String> properties,
                       StreamExecutionEnvironment executionEnvironment)

Creates a corresponding StreamExecutor.

Parameters:

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

executionEnvironment - a StreamExecutionEnvironment to use while executing Table programs.

Returns:

instance of a Executor

create

public Executor create(Map<String,String> properties)

Description copied from interface: ExecutorFactory

Creates a corresponding Executor.

Specified by:

create in interface ExecutorFactory

Parameters:

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

Returns:

instance of a Executor

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

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