Package org.apache.flink.table.api

Class EnvironmentSettings.Builder

java.lang.Object

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

Enclosing class:

EnvironmentSettings

@PublicEvolving
public static class EnvironmentSettings.Builder
extends Object

A builder for EnvironmentSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	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	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.
EnvironmentSettings.Builder	withCatalogStore(CatalogStore catalogStore)
EnvironmentSettings.Builder	withClassLoader(ClassLoader classLoader)	Specifies the classloader to use in the planner for operations related to code generation, UDF loading, operations requiring reflections on user classes, discovery of factories.
EnvironmentSettings.Builder	withConfiguration(Configuration configuration)	Add extra configuration to EnvironmentSettings.
EnvironmentSettings.Builder	withSecretStore(SecretStore secretStore)	Specifies the SecretStore to be used for managing secrets in the TableEnvironment.
EnvironmentSettings.Builder	withSqlFactory(SqlFactory sqlFactory)	Provides a way to customize the process of serializing Table API to a SQL string.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

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 is an in-memory catalog that will be used to store all temporary objects (e.g. from TableEnvironment.createTemporaryView(String, Table) or TableEnvironment.createTemporarySystemFunction(String, UserDefinedFunction)) that cannot be persisted because they have no serializable representation.

It will also be the initial value for the current catalog which can be altered via TableEnvironment.useCatalog(String).

Default: TableConfigOptions.TABLE_DATABASE_NAME.defaultValue().

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.

This database is an in-memory database that will be used to store all temporary objects (e.g. from TableEnvironment.createTemporaryView(String, Table) or TableEnvironment.createTemporarySystemFunction(String, UserDefinedFunction)) that cannot be persisted because they have no serializable representation.

It will also be the initial value for the current database which can be altered via TableEnvironment.useDatabase(String).

Default: TableConfigOptions.TABLE_DATABASE_NAME.defaultValue().

withConfiguration

public EnvironmentSettings.Builder withConfiguration(Configuration configuration)

Add extra configuration to EnvironmentSettings.

withClassLoader

public EnvironmentSettings.Builder withClassLoader(ClassLoader classLoader)

Specifies the classloader to use in the planner for operations related to code generation, UDF loading, operations requiring reflections on user classes, discovery of factories.

By default, this is configured using Thread.currentThread().getContextClassLoader().

Modify the ClassLoader only if you know what you're doing.

withCatalogStore

public EnvironmentSettings.Builder withCatalogStore(CatalogStore catalogStore)

withSqlFactory

public EnvironmentSettings.Builder withSqlFactory(SqlFactory sqlFactory)

Provides a way to customize the process of serializing Table API to a SQL string. This is useful, for example, for customizing the serialization of inline functions.

withSecretStore

public EnvironmentSettings.Builder withSecretStore(SecretStore secretStore)

Specifies the SecretStore to be used for managing secrets in the TableEnvironment.

The secret store allows for secure storage and retrieval of sensitive configuration data such as credentials, tokens, and passwords.

Parameters:

secretStore - the secret store instance to use

Returns:

this builder

build

public EnvironmentSettings build()

Returns an immutable instance of EnvironmentSettings.