@PublicEvolving public class EnvironmentSettings extends Object
TableEnvironment
and cannot be changed afterwards.
Example:
EnvironmentSettings.newInstance()
.inStreamingMode()
.withBuiltInCatalogName("default_catalog")
.withBuiltInDatabaseName("default_database")
.build()
inStreamingMode()
or inBatchMode()
might be convenient as shortcuts.
Modifier and Type | Class and Description |
---|---|
static class |
EnvironmentSettings.Builder
A builder for
EnvironmentSettings . |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_BUILTIN_CATALOG |
static String |
DEFAULT_BUILTIN_DATABASE |
Modifier and Type | Method and Description |
---|---|
static EnvironmentSettings |
fromConfiguration(ReadableConfig 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 . |
String |
getExecutor()
Returns the
Executor that should submit and execute table programs. |
String |
getPlanner()
Returns the identifier of the
Planner to be used. |
static EnvironmentSettings |
inBatchMode()
Creates a default instance of
EnvironmentSettings in batch execution mode. |
static EnvironmentSettings |
inStreamingMode()
Creates a default instance of
EnvironmentSettings in streaming execution mode. |
boolean |
isBlinkPlanner()
Deprecated.
The old planner has been removed in Flink 1.14. Since there is only one planner
left (previously called the 'blink' planner), this method is obsolete and will be removed
in future versions.
|
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 . |
Configuration |
toConfiguration()
Convert the environment setting to the
Configuration . |
public static final String DEFAULT_BUILTIN_CATALOG
public static final String DEFAULT_BUILTIN_DATABASE
public static EnvironmentSettings inStreamingMode()
EnvironmentSettings
in streaming execution mode.
In this mode, both bounded and unbounded data streams can be processed.
This method is a shortcut for creating a TableEnvironment
with little code. Use
the builder provided in newInstance()
for advanced settings.
public static EnvironmentSettings inBatchMode()
EnvironmentSettings
in batch execution mode.
This mode is highly optimized for batch scenarios. Only bounded data streams can be processed in this mode.
This method is a shortcut for creating a TableEnvironment
with little code. Use
the builder provided in newInstance()
for advanced settings.
public static EnvironmentSettings.Builder newInstance()
EnvironmentSettings
.public static EnvironmentSettings fromConfiguration(ReadableConfig configuration)
EnvironmentSettings
from configuration.public Configuration toConfiguration()
Configuration
.public String getBuiltInCatalogName()
TableEnvironment
.public String getBuiltInDatabaseName()
TableEnvironment
.public boolean isStreamingMode()
TableEnvironment
should work in a batch or streaming mode.@Deprecated public boolean isBlinkPlanner()
TableEnvironment
should work in the blink planner or old planner.Copyright © 2014–2023 The Apache Software Foundation. All rights reserved.