org.apache.flink.table.client.gateway.local

Class LocalExecutor

java.lang.Object

org.apache.flink.table.client.gateway.local.LocalExecutor

All Implemented Interfaces:

Executor

public class LocalExecutor
extends Object
implements Executor

Executor that performs the Flink communication locally. The calls are blocking depending on the response time to the Flink cluster. Flink jobs are not blocking.

Constructor Summary

Constructors

Constructor and Description
LocalExecutor(DefaultContext defaultContext) Creates a local executor for submitting table programs and retrieving results.

Method Summary

Modifier and Type	Method and Description
void	cancelQuery(String sessionId, String resultId) Cancels a table program and stops the result retrieval.
void	closeSession(String sessionId) Close the resources of session for given session id.
List<String>	completeStatement(String sessionId, String statement, int position) Returns a list of completion hints for the given statement at the given position.
TableResultInternal	executeModifyOperations(String sessionId, List<ModifyOperation> operations) Executes modify operations, and return TableResult as execution result.
TableResultInternal	executeOperation(String sessionId, Operation operation) Executes an operation, and return TableResult as execution result.
ResultDescriptor	executeQuery(String sessionId, QueryOperation query) Submits a Flink SQL query job (detached) and returns the result descriptor.
protected ExecutionContext	getExecutionContext(String sessionId) Get the existed ExecutionContext from contextMap, or thrown exception if does not exist.
ReadableConfig	getSessionConfig(String sessionId) Returns a ReadableConfig of all session configurations that are defined by the executor and the session.
Map<String,String>	getSessionConfigMap(String sessionId) Returns a copy of Map of all session configurations that are defined by the executor and the session.
String	openSession(String sessionId) Open a new session by using the given session id.
Operation	parseStatement(String sessionId, String statement) Parse a SQL statement to Operation.
void	removeJar(String sessionId, String jarUrl) Remove the JAR resource from the classloader with specified session.
void	resetSessionProperties(String sessionId) Reset all the properties for the given session identifier.
void	resetSessionProperty(String sessionId, String key) Reset given key's the session property for default value, if key is not defined in config file, then remove it.
TypedResult<List<RowData>>	retrieveResultChanges(String sessionId, String resultId) Asks for the next changelog results (non-blocking).
List<RowData>	retrieveResultPage(String resultId, int page) Returns the rows that are part of the current page or throws an exception if the snapshot has been expired.
void	setSessionProperty(String sessionId, String key, String value) Set given key's session property to the specific value.
TypedResult<Integer>	snapshotResult(String sessionId, String resultId, int pageSize) Creates an immutable result snapshot of the running Flink job.
void	start() Starts the executor and ensures that its is ready for commands to be executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalExecutor

public LocalExecutor(DefaultContext defaultContext)

Creates a local executor for submitting table programs and retrieving results.

Method Detail

start

public void start()

Description copied from interface: Executor

Starts the executor and ensures that its is ready for commands to be executed.

Specified by:

start in interface Executor

openSession

public String openSession(@Nullable
                          String sessionId)
                   throws SqlExecutionException

Description copied from interface: Executor

Open a new session by using the given session id.

Specified by:

openSession in interface Executor

Parameters:

sessionId - session identifier.

Returns:

used session identifier to track the session.

Throws:

SqlExecutionException - if any error happen

closeSession

public void closeSession(String sessionId)
                  throws SqlExecutionException

Description copied from interface: Executor

Close the resources of session for given session id.

Specified by:

closeSession in interface Executor

Parameters:

sessionId - session identifier

Throws:

SqlExecutionException - if any error happen

getExecutionContext

@VisibleForTesting
protected ExecutionContext getExecutionContext(String sessionId)
                                                           throws SqlExecutionException

Get the existed ExecutionContext from contextMap, or thrown exception if does not exist.

Throws:

SqlExecutionException

getSessionConfigMap

public Map<String,String> getSessionConfigMap(String sessionId)
                                       throws SqlExecutionException

Description copied from interface: Executor

Returns a copy of Map of all session configurations that are defined by the executor and the session.

Both this method and Executor.getSessionConfig(String) return the same configuration set, but different return type.

Specified by:

getSessionConfigMap in interface Executor

Throws:

SqlExecutionException

getSessionConfig

public ReadableConfig getSessionConfig(String sessionId)
                                throws SqlExecutionException

Description copied from interface: Executor

Returns a ReadableConfig of all session configurations that are defined by the executor and the session.

Both this method and Executor.getSessionConfigMap(String) return the same configuration set, but different return type.

Specified by:

getSessionConfig in interface Executor

Throws:

SqlExecutionException

resetSessionProperties

public void resetSessionProperties(String sessionId)
                            throws SqlExecutionException

Description copied from interface: Executor

Reset all the properties for the given session identifier.

Specified by:

resetSessionProperties in interface Executor

Parameters:

sessionId - to identifier the session

Throws:

SqlExecutionException - if any error happen.

resetSessionProperty

public void resetSessionProperty(String sessionId,
                                 String key)
                          throws SqlExecutionException

Description copied from interface: Executor

Reset given key's the session property for default value, if key is not defined in config file, then remove it.

Specified by:

resetSessionProperty in interface Executor

Parameters:

sessionId - to identifier the session

key - of need to reset the session property

Throws:

SqlExecutionException - if any error happen.

setSessionProperty

public void setSessionProperty(String sessionId,
                               String key,
                               String value)
                        throws SqlExecutionException

Description copied from interface: Executor

Set given key's session property to the specific value.

Specified by:

setSessionProperty in interface Executor

key - of the session property

value - of the session property

Throws:

SqlExecutionException - if any error happen.

parseStatement

public Operation parseStatement(String sessionId,
                                String statement)
                         throws SqlExecutionException

Description copied from interface: Executor

Parse a SQL statement to Operation.

Specified by:

parseStatement in interface Executor

Throws:

SqlExecutionException

completeStatement

public List<String> completeStatement(String sessionId,
                                      String statement,
                                      int position)

Description copied from interface: Executor

Returns a list of completion hints for the given statement at the given position.

Specified by:

completeStatement in interface Executor

executeOperation

public TableResultInternal executeOperation(String sessionId,
                                            Operation operation)
                                     throws SqlExecutionException

Description copied from interface: Executor

Executes an operation, and return TableResult as execution result.

Specified by:

executeOperation in interface Executor

Throws:

SqlExecutionException

executeModifyOperations

public TableResultInternal executeModifyOperations(String sessionId,
                                                   List<ModifyOperation> operations)
                                            throws SqlExecutionException

Description copied from interface: Executor

Executes modify operations, and return TableResult as execution result.

Specified by:

executeModifyOperations in interface Executor

Throws:

SqlExecutionException

executeQuery

public ResultDescriptor executeQuery(String sessionId,
                                     QueryOperation query)
                              throws SqlExecutionException

Description copied from interface: Executor

Submits a Flink SQL query job (detached) and returns the result descriptor.

Specified by:

executeQuery in interface Executor

Throws:

SqlExecutionException

retrieveResultChanges

public TypedResult<List<RowData>> retrieveResultChanges(String sessionId,
                                                        String resultId)
                                                 throws SqlExecutionException

Description copied from interface: Executor

Asks for the next changelog results (non-blocking).

Specified by:

retrieveResultChanges in interface Executor

Throws:

SqlExecutionException

snapshotResult

public TypedResult<Integer> snapshotResult(String sessionId,
                                           String resultId,
                                           int pageSize)
                                    throws SqlExecutionException

Description copied from interface: Executor

Creates an immutable result snapshot of the running Flink job. Throws an exception if no Flink job can be found. Returns the number of pages.

Specified by:

snapshotResult in interface Executor

Throws:

SqlExecutionException

retrieveResultPage

public List<RowData> retrieveResultPage(String resultId,
                                        int page)
                                 throws SqlExecutionException

Description copied from interface: Executor

Returns the rows that are part of the current page or throws an exception if the snapshot has been expired.

Specified by:

retrieveResultPage in interface Executor

Throws:

SqlExecutionException

cancelQuery

public void cancelQuery(String sessionId,
                        String resultId)
                 throws SqlExecutionException

Description copied from interface: Executor

Cancels a table program and stops the result retrieval. Blocking until cancellation command has been sent to cluster.

Specified by:

cancelQuery in interface Executor

Throws:

SqlExecutionException

removeJar

public void removeJar(String sessionId,
                      String jarUrl)

Description copied from interface: Executor

Remove the JAR resource from the classloader with specified session.

Specified by:

removeJar in interface Executor