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(Environment defaultEnvironment, List<URL> dependencies, org.apache.flink.configuration.Configuration flinkConfig, org.apache.flink.client.cli.CustomCommandLine commandLine, org.apache.flink.client.deployment.ClusterClientServiceLoader clusterClientServiceLoader) Constructor for testing purposes.
LocalExecutor(URL defaultEnv, List<URL> jars, List<URL> libraries) 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.
ResultDescriptor	executeQuery(String sessionId, String query) Submits a Flink SQL query job (detached) and returns the result descriptor.
org.apache.flink.table.api.TableResult	executeSql(String sessionId, String statement) Executes a SQL statement, and return TableResult as execution result.
ProgramTargetDescriptor	executeUpdate(String sessionId, String statement) Submits a Flink SQL update statement such as INSERT INTO.
protected ExecutionContext<?>	getExecutionContext(String sessionId) Get the existed ExecutionContext from contextMap, or thrown exception if does not exist.
Map<String,String>	getSessionProperties(String sessionId) Lists all session properties that are defined by the executor and the session.
org.apache.flink.table.delegation.Parser	getSqlParser(String sessionId) Returns a sql parser instance.
List<String>	listModules(String sessionId) Lists all modules known to the executor in their loaded order.
String	openSession(SessionContext sessionContext) Open a new session by using the given SessionContext.
void	resetSessionProperties(String sessionId) Reset all the properties for the given session identifier.
TypedResult<List<org.apache.flink.api.java.tuple.Tuple2<Boolean,org.apache.flink.types.Row>>>	retrieveResultChanges(String sessionId, String resultId) Asks for the next changelog results (non-blocking).
List<org.apache.flink.types.Row>	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(URL defaultEnv,
                     List<URL> jars,
                     List<URL> libraries)

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

LocalExecutor

public LocalExecutor(Environment defaultEnvironment,
                     List<URL> dependencies,
                     org.apache.flink.configuration.Configuration flinkConfig,
                     org.apache.flink.client.cli.CustomCommandLine commandLine,
                     org.apache.flink.client.deployment.ClusterClientServiceLoader clusterClientServiceLoader)

Constructor for testing purposes.

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(SessionContext sessionContext)
                   throws SqlExecutionException

Description copied from interface: Executor

Open a new session by using the given SessionContext.

Specified by:

openSession in interface Executor

Parameters:

sessionContext - context to create new session.

Returns:

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

getSessionProperties

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

Description copied from interface: Executor

Lists all session properties that are defined by the executor and the session.

Specified by:

getSessionProperties 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.

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.

executeSql

public org.apache.flink.table.api.TableResult executeSql(String sessionId,
                                                         String statement)
                                                  throws SqlExecutionException

Description copied from interface: Executor

Executes a SQL statement, and return TableResult as execution result.

Specified by:

executeSql in interface Executor

Throws:

SqlExecutionException

listModules

public List<String> listModules(String sessionId)
                         throws SqlExecutionException

Description copied from interface: Executor

Lists all modules known to the executor in their loaded order.

Specified by:

listModules in interface Executor

Throws:

SqlExecutionException

getSqlParser

public org.apache.flink.table.delegation.Parser getSqlParser(String sessionId)

Description copied from interface: Executor

Returns a sql parser instance.

Specified by:

getSqlParser in interface Executor

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

executeQuery

public ResultDescriptor executeQuery(String sessionId,
                                     String 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<org.apache.flink.api.java.tuple.Tuple2<Boolean,org.apache.flink.types.Row>>> 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<org.apache.flink.types.Row> 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

executeUpdate

public ProgramTargetDescriptor executeUpdate(String sessionId,
                                             String statement)
                                      throws SqlExecutionException

Description copied from interface: Executor

Submits a Flink SQL update statement such as INSERT INTO.

Specified by:

executeUpdate in interface Executor

Parameters:

sessionId - to identify the user session.

statement - SQL update statement (currently only INSERT INTO is supported)

Returns:

information about the target of the submitted Flink job

Throws:

SqlExecutionException