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, Configuration flinkConfig, CustomCommandLine<?> commandLine) 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(SessionContext session, String resultId) Cancels a table program and stops the result retrieval.
List<String>	completeStatement(SessionContext session, String statement, int position) Returns a list of completion hints for the given statement at the given position.
ResultDescriptor	executeQuery(SessionContext session, String query) Submits a Flink SQL query job (detached) and returns the result descriptor.
ProgramTargetDescriptor	executeUpdate(SessionContext session, String statement) Submits a Flink SQL update statement such as INSERT INTO.
String	explainStatement(SessionContext session, String statement) Returns a string-based explanation about AST and execution plan of the given statement.
Map<String,String>	getSessionProperties(SessionContext session) Lists all session properties that are defined by the executor and the session.
TableSchema	getTableSchema(SessionContext session, String name) Returns the schema of a table.
List<String>	listTables(SessionContext session) Lists all tables known to the executor.
List<String>	listUserDefinedFunctions(SessionContext session) Lists all user-defined functions known to the executor.
TypedResult<List<Tuple2<Boolean,Row>>>	retrieveResultChanges(SessionContext session, String resultId) Asks for the next changelog results (non-blocking).
List<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.
TypedResult<Integer>	snapshotResult(SessionContext session, 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.
void	stop(SessionContext session) Stops the executor.
void	validateSession(SessionContext session) Validates the current session.

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,
                     Configuration flinkConfig,
                     CustomCommandLine<?> commandLine)

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

getSessionProperties

public Map<String,String> getSessionProperties(SessionContext session)
                                        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

listTables

public List<String> listTables(SessionContext session)
                        throws SqlExecutionException

Description copied from interface: Executor

Lists all tables known to the executor.

Specified by:

listTables in interface Executor

Throws:

SqlExecutionException

listUserDefinedFunctions

public List<String> listUserDefinedFunctions(SessionContext session)
                                      throws SqlExecutionException

Description copied from interface: Executor

Lists all user-defined functions known to the executor.

Specified by:

listUserDefinedFunctions in interface Executor

Throws:

SqlExecutionException

getTableSchema

public TableSchema getTableSchema(SessionContext session,
                                  String name)
                           throws SqlExecutionException

Description copied from interface: Executor

Returns the schema of a table. Throws an exception if the table could not be found. The schema might contain time attribute types for helping the user during debugging a query.

Specified by:

getTableSchema in interface Executor

Throws:

SqlExecutionException

explainStatement

public String explainStatement(SessionContext session,
                               String statement)
                        throws SqlExecutionException

Description copied from interface: Executor

Returns a string-based explanation about AST and execution plan of the given statement.

Specified by:

explainStatement in interface Executor

Throws:

SqlExecutionException

completeStatement

public List<String> completeStatement(SessionContext session,
                                      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(SessionContext session,
                                     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<Tuple2<Boolean,Row>>> retrieveResultChanges(SessionContext session,
                                                                    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(SessionContext session,
                                           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<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(SessionContext session,
                        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(SessionContext session,
                                             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:

session - context in with the statement is executed

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

Returns:

information about the target of the submitted Flink job

Throws:

SqlExecutionException

validateSession

public void validateSession(SessionContext session)
                     throws SqlExecutionException

Description copied from interface: Executor

Validates the current session. For example, it checks whether all views are still valid.

Specified by:

validateSession in interface Executor

Throws:

SqlExecutionException

stop

public void stop(SessionContext session)

Description copied from interface: Executor

Stops the executor.

Specified by:

stop in interface Executor