org.apache.flink.table.api

Class TableConfig

java.lang.Object

org.apache.flink.table.api.TableConfig

@PublicEvolving
public class TableConfig
extends Object

Configuration for the current TableEnvironment session to adjust Table & SQL API programs.

For common or important configuration options, this class provides getters and setters methods with detailed inline documentation.

For more advanced configuration, users can directly access the underlying key-value map via getConfiguration(). Currently, key-value options are only supported for the Blink planner. Users can configure also underlying execution parameters via this object. E.g.

 tEnv.getConfig().addConfiguration(
          new Configuration()
              .set(CoreOptions.DEFAULT_PARALLELISM, 128)
              .set(PipelineOptions.AUTO_WATERMARK_INTERVAL, Duration.ofMillis(800))
              .set(ExecutionCheckpointingOptions.CHECKPOINTING_INTERVAL, Duration.ofSeconds(30))
      );
 

Note: Because options are read at different point in time when performing operations, it is recommended to set configuration options early after instantiating a table environment.

See Also:

ExecutionConfigOptions, OptimizerConfigOptions

Constructor Summary

Constructors

Constructor and Description
TableConfig()

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(Configuration configuration) Adds the given key-value configuration to the underlying configuration.
void	addJobParameter(String key, String value) Sets a custom user parameter that can be accessed via FunctionContext.getJobParameter(String, String).
Configuration	getConfiguration() Gives direct access to the underlying key-value map for advanced configuration.
MathContext	getDecimalContext() Returns the default context for decimal division calculation.
static TableConfig	getDefault()
java.time.ZoneId	getLocalTimeZone() Returns the current session time zone id.
Integer	getMaxGeneratedCodeLength() Returns the current threshold where generated code will be split into sub-function calls.
long	getMaxIdleStateRetentionTime()
long	getMinIdleStateRetentionTime()
Boolean	getNullCheck() Returns the NULL check.
PlannerConfig	getPlannerConfig() Returns the current configuration of Planner for Table API and SQL queries.
SqlDialect	getSqlDialect() Returns the current SQL dialect.
void	setDecimalContext(MathContext decimalContext) Sets the default context for decimal division calculation.
void	setIdleStateRetentionTime(Time minTime, Time maxTime) Specifies a minimum and a maximum time interval for how long idle state, i.e., state which was not updated, will be retained.
void	setLocalTimeZone(java.time.ZoneId zoneId) Sets the current session time zone id.
void	setMaxGeneratedCodeLength(Integer maxGeneratedCodeLength) Returns the current threshold where generated code will be split into sub-function calls.
void	setNullCheck(Boolean nullCheck) Sets the NULL check.
void	setPlannerConfig(PlannerConfig plannerConfig) Sets the configuration of Planner for Table API and SQL queries.
void	setSqlDialect(SqlDialect sqlDialect) Sets the current SQL dialect to parse a SQL query.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableConfig

public TableConfig()

Method Detail

getConfiguration

public Configuration getConfiguration()

Gives direct access to the underlying key-value map for advanced configuration.

addConfiguration

public void addConfiguration(Configuration configuration)

Adds the given key-value configuration to the underlying configuration. It overwrites existing keys.

Parameters:

configuration - key-value configuration to be added

getSqlDialect

public SqlDialect getSqlDialect()

Returns the current SQL dialect.

setSqlDialect

public void setSqlDialect(SqlDialect sqlDialect)

Sets the current SQL dialect to parse a SQL query. Flink's SQL behavior by default.

getLocalTimeZone

public java.time.ZoneId getLocalTimeZone()

Returns the current session time zone id. It is used when converting to/from TIMESTAMP WITH LOCAL TIME ZONE. See setLocalTimeZone(ZoneId) for more details.

See Also:

LocalZonedTimestampType

setLocalTimeZone

public void setLocalTimeZone(java.time.ZoneId zoneId)

Sets the current session time zone id. It is used when converting to/from DataTypes.TIMESTAMP_WITH_LOCAL_TIME_ZONE(). Internally, timestamps with local time zone are always represented in the UTC time zone. However, when converting to data types that don't include a time zone (e.g. TIMESTAMP, TIME, or simply STRING), the session time zone is used during conversion.

Example:

 TableEnvironment tEnv = ...
 TableConfig config = tEnv.getConfig
 config.setLocalTimeZone(ZoneOffset.ofHours(2));
 tEnv("CREATE TABLE testTable (id BIGINT, tmstmp TIMESTAMP WITH LOCAL TIME ZONE)");
 tEnv("INSERT INTO testTable VALUES ((1, '2000-01-01 2:00:00'), (2, TIMESTAMP '2000-01-01 2:00:00'))");
 tEnv("SELECT * FROM testTable"); // query with local time zone set to UTC+2
 

should produce:

 =============================
    id   |       tmstmp
 =============================
    1    | 2000-01-01 2:00:00'
    2    | 2000-01-01 2:00:00'
 

If we change the local time zone and query the same table:

 config.setLocalTimeZone(ZoneOffset.ofHours(0));
 tEnv("SELECT * FROM testTable"); // query with local time zone set to UTC+0
 

we should get:

 =============================
    id   |       tmstmp
 =============================
    1    | 2000-01-01 0:00:00'
    2    | 2000-01-01 0:00:00'
 

See Also:

LocalZonedTimestampType

getNullCheck

public Boolean getNullCheck()

Returns the NULL check. If enabled, all fields need to be checked for NULL first.

setNullCheck

public void setNullCheck(Boolean nullCheck)

Sets the NULL check. If enabled, all fields need to be checked for NULL first.

getPlannerConfig

public PlannerConfig getPlannerConfig()

Returns the current configuration of Planner for Table API and SQL queries.

setPlannerConfig

public void setPlannerConfig(PlannerConfig plannerConfig)

Sets the configuration of Planner for Table API and SQL queries. Changing the configuration has no effect after the first query has been defined.

getDecimalContext

public MathContext getDecimalContext()

Returns the default context for decimal division calculation. MathContext.DECIMAL128 by default.

setDecimalContext

public void setDecimalContext(MathContext decimalContext)

Sets the default context for decimal division calculation. MathContext.DECIMAL128 by default.

getMaxGeneratedCodeLength

public Integer getMaxGeneratedCodeLength()

Returns the current threshold where generated code will be split into sub-function calls. Java has a maximum method length of 64 KB. This setting allows for finer granularity if necessary. Default is 64000.

setMaxGeneratedCodeLength

public void setMaxGeneratedCodeLength(Integer maxGeneratedCodeLength)

Returns the current threshold where generated code will be split into sub-function calls. Java has a maximum method length of 64 KB. This setting allows for finer granularity if necessary. Default is 64000.

setIdleStateRetentionTime

public void setIdleStateRetentionTime(Time minTime,
                                      Time maxTime)

Specifies a minimum and a maximum time interval for how long idle state, i.e., state which was not updated, will be retained. State will never be cleared until it was idle for less than the minimum time and will never be kept if it was idle for more than the maximum time.

When new data arrives for previously cleaned-up state, the new data will be handled as if it was the first data. This can result in previous results being overwritten.

Set to 0 (zero) to never clean-up the state.

NOTE: Cleaning up state requires additional bookkeeping which becomes less expensive for larger differences of minTime and maxTime. The difference between minTime and maxTime must be at least 5 minutes.

Parameters:

minTime - The minimum time interval for which idle state is retained. Set to 0 (zero) to never clean-up the state.

maxTime - The maximum time interval for which idle state is retained. Must be at least 5 minutes greater than minTime. Set to 0 (zero) to never clean-up the state.

getMinIdleStateRetentionTime

public long getMinIdleStateRetentionTime()

Returns:

The minimum time until state which was not updated will be retained.

getMaxIdleStateRetentionTime

public long getMaxIdleStateRetentionTime()

Returns:

The maximum time until state which was not updated will be retained.

addJobParameter

@Experimental
public void addJobParameter(String key,
                                          String value)

Sets a custom user parameter that can be accessed via FunctionContext.getJobParameter(String, String).

This will add an entry to the current value of PipelineOptions.GLOBAL_JOB_PARAMETERS.

It is also possible to set multiple parameters at once, which will override any previously set parameters:

 Map<String, String> params = ...
 TableConfig config = tEnv.getConfig;
 config.getConfiguration().set(PipelineOptions.GLOBAL_JOB_PARAMETERS, params);
 

getDefault

public static TableConfig getDefault()