org.apache.flink.table.client.gateway.context

Class SessionContext

java.lang.Object

org.apache.flink.table.client.gateway.context.SessionContext

public class SessionContext
extends Object

Context describing a session, it's mainly used for user to open a new session in the backend. If client request to open a new session, the backend Executor will maintain the session context map util users close it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionContext.SessionState session state.

Method Summary

Modifier and Type	Method and Description
void	close() Close resources, e.g.
static SessionContext	create(DefaultContext defaultContext, String sessionId)
Map<String,String>	getConfigMap()
ExecutionContext	getExecutionContext()
ReadableConfig	getReadableConfig()
String	getSessionId()
void	reset() Reset properties to default.
void	reset(String key) Reset key's property to default.
void	set(String key, String value) Set properties.

Methods inherited from class java.lang.Object

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

Method Detail

getSessionId

public String getSessionId()

getExecutionContext

public ExecutionContext getExecutionContext()

getReadableConfig

public ReadableConfig getReadableConfig()

getConfigMap

public Map<String,String> getConfigMap()

reset

public void reset()

Reset properties to default. It will rebuild a new ExecutionContext.

Reset runtime configurations specific to the current session which were set via the SET command to their default values.

reset

public void reset(String key)

Reset key's property to default. It will rebuild a new ExecutionContext.

If key is not defined in default config file, remove it from session configuration.

set

public void set(String key,
                String value)

Set properties. It will rebuild a new ExecutionContext

close

public void close()

Close resources, e.g. catalogs.

create

public static SessionContext create(DefaultContext defaultContext,
                                    String sessionId)