org.apache.flink.table.planner.utils

Class DummyStreamExecutionEnvironment

java.lang.Object

org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

org.apache.flink.table.planner.utils.DummyStreamExecutionEnvironment

public class DummyStreamExecutionEnvironment
extends org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

This is dummy StreamExecutionEnvironment, which holds a real StreamExecutionEnvironment, shares all configurations of the real environment, and disables all configuration setting methods.

When translating relational plan to execution plan in the Planner, the generated Transformations will be added into StreamExecutionEnvironment's buffer, and they will be cleared only when StreamExecutionEnvironment.execute() method is called. Each TableEnvironment instance holds an immutable StreamExecutionEnvironment instance. If there are multiple translations (not all for `execute`, e.g. `explain` and then `execute`) in one TableEnvironment instance, the transformation buffer is dirty, and execution result may be incorrect.

This dummy StreamExecutionEnvironment is only used for buffering the transformations generated in the planner. A new dummy StreamExecutionEnvironment instance should be created for each translation, and this could avoid dirty the transformation buffer of the real StreamExecutionEnvironment instance.

All set methods (e.g. `setXX`, `enableXX`, `disableXX`, etc) are disabled to prohibit changing configuration, all get methods (e.g. `getXX`, `isXX`, etc) will be delegated to the real StreamExecutionEnvironment. `execute`, `getStreamGraph`, `getExecutionPlan` methods are also disabled, while `addOperator` method is enabled to allow the planner to add the generated transformations to the dummy StreamExecutionEnvironment.

This class could be removed once the StreamTableSource interface and StreamTableSink interface are reworked.

NOTE: Please remove com.esotericsoftware.kryo item in the whitelist of checkCodeDependencies() method in test_table_shaded_dependencies.sh end-to-end test when this class is removed.

Field Summary

Fields inherited from class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

cacheFile, DEFAULT_JOB_NAME, isChainingEnabled, transformations

Constructor Summary

Constructors

Constructor and Description
DummyStreamExecutionEnvironment(org.apache.flink.streaming.api.environment.StreamExecutionEnvironment realExecEnv)

Method Summary

Modifier and Type	Method and Description
void	addDefaultKryoSerializer(Class<?> type, Class<? extends com.esotericsoftware.kryo.Serializer<?>> serializerClass)
<T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void	addDefaultKryoSerializer(Class<?> type, T serializer)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	disableOperatorChaining()
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	enableCheckpointing()
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	enableCheckpointing(long interval)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	enableCheckpointing(long interval, org.apache.flink.streaming.api.CheckpointingMode mode)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	enableCheckpointing(long interval, org.apache.flink.streaming.api.CheckpointingMode mode, boolean force)
org.apache.flink.api.common.JobExecutionResult	execute()
org.apache.flink.api.common.JobExecutionResult	execute(org.apache.flink.streaming.api.graph.StreamGraph streamGraph)
org.apache.flink.api.common.JobExecutionResult	execute(String jobName)
long	getBufferTimeout()
List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.api.common.cache.DistributedCache.DistributedCacheEntry>>	getCachedFiles()
org.apache.flink.streaming.api.environment.CheckpointConfig	getCheckpointConfig()
org.apache.flink.streaming.api.CheckpointingMode	getCheckpointingMode()
long	getCheckpointInterval()
org.apache.flink.api.common.ExecutionConfig	getConfig()
String	getExecutionPlan()
int	getMaxParallelism()
int	getNumberOfExecutionRetries()
int	getParallelism()
org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration	getRestartStrategy()
org.apache.flink.runtime.state.StateBackend	getStateBackend()
org.apache.flink.streaming.api.graph.StreamGraph	getStreamGraph()
org.apache.flink.streaming.api.graph.StreamGraph	getStreamGraph(String jobName)
org.apache.flink.streaming.api.TimeCharacteristic	getStreamTimeCharacteristic()
boolean	isChainingEnabled()
boolean	isForceCheckpointing()
void	registerCachedFile(String filePath, String name)
void	registerCachedFile(String filePath, String name, boolean executable)
void	registerType(Class<?> type)
void	registerTypeWithKryoSerializer(Class<?> type, Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)
<T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void	registerTypeWithKryoSerializer(Class<?> type, T serializer)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	setBufferTimeout(long timeoutMillis)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	setMaxParallelism(int maxParallelism)
void	setNumberOfExecutionRetries(int numberOfExecutionRetries)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	setParallelism(int parallelism)
void	setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)
org.apache.flink.streaming.api.environment.StreamExecutionEnvironment	setStateBackend(org.apache.flink.runtime.state.StateBackend backend)
void	setStreamTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic characteristic)

Methods inherited from class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

addOperator, addSource, addSource, addSource, addSource, clean, clearJobListeners, configure, createInput, createInput, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironment, createLocalEnvironmentWithWebUI, createRemoteEnvironment, createRemoteEnvironment, createRemoteEnvironment, executeAsync, executeAsync, executeAsync, fromCollection, fromCollection, fromCollection, fromCollection, fromElements, fromElements, fromParallelCollection, fromParallelCollection, fromSequence, fromSource, fromSource, generateSequence, getConfiguration, getDefaultLocalParallelism, getExecutionEnvironment, getExecutionEnvironment, getJobListeners, getStreamGraph, getUserClassloader, initializeContextEnvironment, isForceUnalignedCheckpoints, isUnalignedCheckpointsEnabled, readFile, readFile, readFile, readFile, readFileStream, readTextFile, readTextFile, registerJobListener, resetContextEnvironment, setDefaultLocalParallelism, setRuntimeMode, socketTextStream, socketTextStream, socketTextStream, socketTextStream, socketTextStream

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyStreamExecutionEnvironment

public DummyStreamExecutionEnvironment(org.apache.flink.streaming.api.environment.StreamExecutionEnvironment realExecEnv)

Method Detail

getConfig

public org.apache.flink.api.common.ExecutionConfig getConfig()

Overrides:

getConfig in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getCachedFiles

public List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.api.common.cache.DistributedCache.DistributedCacheEntry>> getCachedFiles()

Overrides:

getCachedFiles in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

setParallelism

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment setParallelism(int parallelism)

Overrides:

setParallelism in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

setMaxParallelism

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment setMaxParallelism(int maxParallelism)

Overrides:

setMaxParallelism in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getParallelism

public int getParallelism()

Overrides:

getParallelism in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getMaxParallelism

public int getMaxParallelism()

Overrides:

getMaxParallelism in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

setBufferTimeout

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment setBufferTimeout(long timeoutMillis)

Overrides:

setBufferTimeout in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getBufferTimeout

public long getBufferTimeout()

Overrides:

getBufferTimeout in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

disableOperatorChaining

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment disableOperatorChaining()

Overrides:

disableOperatorChaining in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

isChainingEnabled

public boolean isChainingEnabled()

Overrides:

isChainingEnabled in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getCheckpointConfig

public org.apache.flink.streaming.api.environment.CheckpointConfig getCheckpointConfig()

Overrides:

getCheckpointConfig in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

enableCheckpointing

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment enableCheckpointing(long interval)

Overrides:

enableCheckpointing in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

enableCheckpointing

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment enableCheckpointing(long interval,
                                                                                                 org.apache.flink.streaming.api.CheckpointingMode mode)

Overrides:

enableCheckpointing in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

enableCheckpointing

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment enableCheckpointing(long interval,
                                                                                                 org.apache.flink.streaming.api.CheckpointingMode mode,
                                                                                                 boolean force)

Overrides:

enableCheckpointing in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

enableCheckpointing

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment enableCheckpointing()

Overrides:

enableCheckpointing in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getCheckpointInterval

public long getCheckpointInterval()

Overrides:

getCheckpointInterval in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

isForceCheckpointing

public boolean isForceCheckpointing()

Overrides:

isForceCheckpointing in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getCheckpointingMode

public org.apache.flink.streaming.api.CheckpointingMode getCheckpointingMode()

Overrides:

getCheckpointingMode in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

setStateBackend

public org.apache.flink.streaming.api.environment.StreamExecutionEnvironment setStateBackend(org.apache.flink.runtime.state.StateBackend backend)

Overrides:

setStateBackend in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getStateBackend

public org.apache.flink.runtime.state.StateBackend getStateBackend()

Overrides:

getStateBackend in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

setRestartStrategy

public void setRestartStrategy(org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration restartStrategyConfiguration)

Overrides:

setRestartStrategy in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getRestartStrategy

public org.apache.flink.api.common.restartstrategy.RestartStrategies.RestartStrategyConfiguration getRestartStrategy()

Overrides:

getRestartStrategy in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

setNumberOfExecutionRetries

public void setNumberOfExecutionRetries(int numberOfExecutionRetries)

Overrides:

setNumberOfExecutionRetries in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getNumberOfExecutionRetries

public int getNumberOfExecutionRetries()

Overrides:

getNumberOfExecutionRetries in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

addDefaultKryoSerializer

public <T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void addDefaultKryoSerializer(Class<?> type,
                                                                                                        T serializer)

Overrides:

addDefaultKryoSerializer in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

addDefaultKryoSerializer

public void addDefaultKryoSerializer(Class<?> type,
                                     Class<? extends com.esotericsoftware.kryo.Serializer<?>> serializerClass)

Overrides:

addDefaultKryoSerializer in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

registerTypeWithKryoSerializer

public <T extends com.esotericsoftware.kryo.Serializer<?> & Serializable> void registerTypeWithKryoSerializer(Class<?> type,
                                                                                                              T serializer)

Overrides:

registerTypeWithKryoSerializer in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

registerTypeWithKryoSerializer

public void registerTypeWithKryoSerializer(Class<?> type,
                                           Class<? extends com.esotericsoftware.kryo.Serializer> serializerClass)

Overrides:

registerTypeWithKryoSerializer in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

registerType

public void registerType(Class<?> type)

Overrides:

registerType in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

setStreamTimeCharacteristic

public void setStreamTimeCharacteristic(org.apache.flink.streaming.api.TimeCharacteristic characteristic)

Overrides:

setStreamTimeCharacteristic in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getStreamTimeCharacteristic

public org.apache.flink.streaming.api.TimeCharacteristic getStreamTimeCharacteristic()

Overrides:

getStreamTimeCharacteristic in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

execute

public org.apache.flink.api.common.JobExecutionResult execute()
                                                       throws Exception

Overrides:

execute in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

Throws:

Exception

execute

public org.apache.flink.api.common.JobExecutionResult execute(String jobName)
                                                       throws Exception

Overrides:

execute in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

Throws:

Exception

execute

public org.apache.flink.api.common.JobExecutionResult execute(org.apache.flink.streaming.api.graph.StreamGraph streamGraph)
                                                       throws Exception

Overrides:

execute in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

Throws:

Exception

registerCachedFile

public void registerCachedFile(String filePath,
                               String name)

Overrides:

registerCachedFile in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

registerCachedFile

public void registerCachedFile(String filePath,
                               String name,
                               boolean executable)

Overrides:

registerCachedFile in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getStreamGraph

public org.apache.flink.streaming.api.graph.StreamGraph getStreamGraph()

Overrides:

getStreamGraph in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getStreamGraph

public org.apache.flink.streaming.api.graph.StreamGraph getStreamGraph(String jobName)

Overrides:

getStreamGraph in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment

getExecutionPlan

public String getExecutionPlan()

Overrides:

getExecutionPlan in class org.apache.flink.streaming.api.environment.StreamExecutionEnvironment