org.apache.flink.table.api

Class EnvironmentSettings

java.lang.Object

org.apache.flink.table.api.EnvironmentSettings

@PublicEvolving
public class EnvironmentSettings
extends Object

Defines all parameters that initialize a table environment. Those parameters are used only during instantiation of a TableEnvironment and cannot be changed afterwards.

Example:

 EnvironmentSettings.newInstance()
   .useBlinkPlanner()
   .inStreamingMode()
   .withBuiltInCatalogName("default_catalog")
   .withBuiltInDatabaseName("default_database")
   .build()
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentSettings.Builder A builder for EnvironmentSettings.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME
static String	DEFAULT_BUILTIN_CATALOG
static String	DEFAULT_BUILTIN_DATABASE
static String	STREAMING_MODE

Method Summary

Modifier and Type	Method and Description
static EnvironmentSettings	fromConfiguration(org.apache.flink.configuration.Configuration configuration) Creates an instance of EnvironmentSettings from Configuration.
String	getBuiltInCatalogName() Gets the specified name of the initial catalog to be created when instantiating a TableEnvironment.
String	getBuiltInDatabaseName() Gets the specified name of the default database in the initial catalog to be created when instantiating a TableEnvironment.
boolean	isBlinkPlanner() Tells if the TableEnvironment should work in the blink planner or old planner.
boolean	isStreamingMode() Tells if the TableEnvironment should work in a batch or streaming mode.
static EnvironmentSettings.Builder	newInstance() Creates a builder for creating an instance of EnvironmentSettings.
org.apache.flink.configuration.Configuration	toConfiguration() Convert the environment setting to the Configuration.
Map<String,String>	toExecutorProperties()
Map<String,String>	toPlannerProperties()

Methods inherited from class java.lang.Object

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

Field Detail

STREAMING_MODE

public static final String STREAMING_MODE

See Also:

Constant Field Values

CLASS_NAME

public static final String CLASS_NAME

See Also:

Constant Field Values

DEFAULT_BUILTIN_CATALOG

public static final String DEFAULT_BUILTIN_CATALOG

See Also:

Constant Field Values

DEFAULT_BUILTIN_DATABASE

public static final String DEFAULT_BUILTIN_DATABASE

See Also:

Constant Field Values

Method Detail

newInstance

public static EnvironmentSettings.Builder newInstance()

Creates a builder for creating an instance of EnvironmentSettings.

By default, it does not specify a required planner and will use the one that is available on the classpath via discovery.

fromConfiguration

public static EnvironmentSettings fromConfiguration(org.apache.flink.configuration.Configuration configuration)

Creates an instance of EnvironmentSettings from Configuration.

toConfiguration

public org.apache.flink.configuration.Configuration toConfiguration()

Convert the environment setting to the Configuration.

getBuiltInCatalogName

public String getBuiltInCatalogName()

Gets the specified name of the initial catalog to be created when instantiating a TableEnvironment.

getBuiltInDatabaseName

public String getBuiltInDatabaseName()

Gets the specified name of the default database in the initial catalog to be created when instantiating a TableEnvironment.

isStreamingMode

public boolean isStreamingMode()

Tells if the TableEnvironment should work in a batch or streaming mode.

isBlinkPlanner

public boolean isBlinkPlanner()

Tells if the TableEnvironment should work in the blink planner or old planner.

toPlannerProperties

@Internal
public Map<String,String> toPlannerProperties()

toExecutorProperties

@Internal
public Map<String,String> toExecutorProperties()