org.apache.flink.table.api

Class EnvironmentSettings.Builder

java.lang.Object

org.apache.flink.table.api.EnvironmentSettings.Builder

Enclosing class:

EnvironmentSettings

public static class EnvironmentSettings.Builder
extends Object

A builder for EnvironmentSettings.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EnvironmentSettings	build() Returns an immutable instance of EnvironmentSettings.
EnvironmentSettings.Builder	inBatchMode() Sets that the components should work in a batch mode.
EnvironmentSettings.Builder	inStreamingMode() Sets that the components should work in a streaming mode.
EnvironmentSettings.Builder	useAnyPlanner() Does not set a planner requirement explicitly.
EnvironmentSettings.Builder	useBlinkPlanner() Sets the Blink planner as the required module.
EnvironmentSettings.Builder	useOldPlanner() Deprecated. The old planner will be dropped in Flink 1.14. Please update to the new planner (i.e. Blink planner).
EnvironmentSettings.Builder	withBuiltInCatalogName(String builtInCatalogName) Specifies the name of the initial catalog to be created when instantiating a TableEnvironment.
EnvironmentSettings.Builder	withBuiltInDatabaseName(String builtInDatabaseName) Specifies the name of the default database in the initial catalog to be created when instantiating a TableEnvironment.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

useOldPlanner

@Deprecated
public EnvironmentSettings.Builder useOldPlanner()

Deprecated. The old planner will be dropped in Flink 1.14. Please update to the new planner (i.e. Blink planner).

Sets the old Flink planner as the required module. By default, useBlinkPlanner() is enabled.

useBlinkPlanner

public EnvironmentSettings.Builder useBlinkPlanner()

Sets the Blink planner as the required module.

This is the default behavior.

useAnyPlanner

public EnvironmentSettings.Builder useAnyPlanner()

Does not set a planner requirement explicitly.

A planner will be discovered automatically, if there is only one planner available.

By default, useBlinkPlanner() is enabled.

inBatchMode

public EnvironmentSettings.Builder inBatchMode()

Sets that the components should work in a batch mode. Streaming mode by default.

inStreamingMode

public EnvironmentSettings.Builder inStreamingMode()

Sets that the components should work in a streaming mode. Enabled by default.

withBuiltInCatalogName

public EnvironmentSettings.Builder withBuiltInCatalogName(String builtInCatalogName)

Specifies the name of the initial catalog to be created when instantiating a TableEnvironment. This catalog will be used to store all non-serializable objects such as tables and functions registered via e.g. TableEnvironment#registerTableSink(String, TableSink) or TableEnvironment.registerFunction(String, ScalarFunction). It will also be the initial value for the current catalog which can be altered via TableEnvironment.useCatalog(String).

Default: "default_catalog".

withBuiltInDatabaseName

public EnvironmentSettings.Builder withBuiltInDatabaseName(String builtInDatabaseName)

Specifies the name of the default database in the initial catalog to be created when instantiating a TableEnvironment. The database will be used to store all non-serializable objects such as tables and functions registered via e.g. TableEnvironment#registerTableSink(String, TableSink) or TableEnvironment.registerFunction(String, ScalarFunction). It will also be the initial value for the current database which can be altered via TableEnvironment.useDatabase(String).

Default: "default_database".

build

public EnvironmentSettings build()

Returns an immutable instance of EnvironmentSettings.