org.apache.flink.table.client.gateway

Interface Executor

All Known Implementing Classes:

LocalExecutor

public interface Executor

A gateway for communicating with Flink and other external systems.

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.
void	createTable(String sessionId, String ddl) Create a table with a DDL statement.
void	dropTable(String sessionId, String ddl) Drop a table with a DDL statement.
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.
ProgramTargetDescriptor	executeUpdate(String sessionId, String statement) Submits a Flink SQL update statement such as INSERT INTO.
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.
org.apache.flink.table.api.TableSchema	getTableSchema(String sessionId, String name) Returns the schema of a table.
List<String>	listCatalogs(String sessionid) Lists all registered catalogs.
List<String>	listDatabases(String sessionId) Lists all databases in the current catalog.
List<String>	listFunctions(String sessionId) Lists all functions known to the executor.
List<String>	listModules(String sessionId) Lists all modules known to the executor in their loaded order.
List<String>	listTables(String sessionId) Lists all tables in the current database of the current catalog.
List<String>	listUserDefinedFunctions(String sessionId) Lists all user-defined functions known to the executor.
String	openSession(SessionContext session) 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.
void	useCatalog(String sessionId, String catalogName) Sets a catalog with given name as the current catalog.
void	useDatabase(String sessionId, String databaseName) Sets a database with given name as the current database of the current catalog.

Method Detail

start

void start()
    throws SqlExecutionException

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

Throws:

SqlExecutionException

openSession

String openSession(SessionContext session)
            throws SqlExecutionException

Open a new session by using the given SessionContext.

Parameters:

session - context to create new session.

Returns:

session identifier to track the session.

Throws:

SqlExecutionException - if any error happen

closeSession

void closeSession(String sessionId)
           throws SqlExecutionException

Close the resources of session for given session id.

Parameters:

sessionId - session identifier

Throws:

SqlExecutionException - if any error happen

getSessionProperties

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

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

Throws:

SqlExecutionException

resetSessionProperties

void resetSessionProperties(String sessionId)
                     throws SqlExecutionException

Reset all the properties for the given session identifier.

Parameters:

sessionId - to identifier the session

Throws:

SqlExecutionException - if any error happen.

setSessionProperty

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

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

Parameters:

key - of the session property

value - of the session property

Throws:

SqlExecutionException - if any error happen.

listCatalogs

List<String> listCatalogs(String sessionid)
                   throws SqlExecutionException

Lists all registered catalogs.

Throws:

SqlExecutionException

listDatabases

List<String> listDatabases(String sessionId)
                    throws SqlExecutionException

Lists all databases in the current catalog.

Throws:

SqlExecutionException

createTable

void createTable(String sessionId,
                 String ddl)
          throws SqlExecutionException

Create a table with a DDL statement.

Throws:

SqlExecutionException

dropTable

void dropTable(String sessionId,
               String ddl)
        throws SqlExecutionException

Drop a table with a DDL statement.

Throws:

SqlExecutionException

listTables

List<String> listTables(String sessionId)
                 throws SqlExecutionException

Lists all tables in the current database of the current catalog.

Throws:

SqlExecutionException

listUserDefinedFunctions

List<String> listUserDefinedFunctions(String sessionId)
                               throws SqlExecutionException

Lists all user-defined functions known to the executor.

Throws:

SqlExecutionException

executeSql

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

Executes a SQL statement.

Throws:

SqlExecutionException

listFunctions

List<String> listFunctions(String sessionId)
                    throws SqlExecutionException

Lists all functions known to the executor.

Throws:

SqlExecutionException

listModules

List<String> listModules(String sessionId)
                  throws SqlExecutionException

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

Throws:

SqlExecutionException

useCatalog

void useCatalog(String sessionId,
                String catalogName)
         throws SqlExecutionException

Sets a catalog with given name as the current catalog.

Throws:

SqlExecutionException

useDatabase

void useDatabase(String sessionId,
                 String databaseName)
          throws SqlExecutionException

Sets a database with given name as the current database of the current catalog.

Throws:

SqlExecutionException

getTableSchema

org.apache.flink.table.api.TableSchema getTableSchema(String sessionId,
                                                      String name)
                                               throws SqlExecutionException

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.

Throws:

SqlExecutionException

getSqlParser

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

Returns a sql parser instance.

completeStatement

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

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

executeQuery

ResultDescriptor executeQuery(String sessionId,
                              String query)
                       throws SqlExecutionException

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

Throws:

SqlExecutionException

retrieveResultChanges

TypedResult<List<org.apache.flink.api.java.tuple.Tuple2<Boolean,org.apache.flink.types.Row>>> retrieveResultChanges(String sessionId,
                                                                                                                    String resultId)
                                                                                                             throws SqlExecutionException

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

Throws:

SqlExecutionException

snapshotResult

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

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.

Throws:

SqlExecutionException

retrieveResultPage

List<org.apache.flink.types.Row> retrieveResultPage(String resultId,
                                                    int page)
                                             throws SqlExecutionException

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

Throws:

SqlExecutionException

cancelQuery

void cancelQuery(String sessionId,
                 String resultId)
          throws SqlExecutionException

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

Throws:

SqlExecutionException

executeUpdate

ProgramTargetDescriptor executeUpdate(String sessionId,
                                      String statement)
                               throws SqlExecutionException

Submits a Flink SQL update statement such as INSERT INTO.

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