org.apache.flink.table.client.gateway

接口 Executor

所有已知实现类:

LocalExecutor

public interface Executor

A gateway for communicating with Flink and other external systems.

方法概要

限定符和类型	方法和说明
void	addJar(String sessionId, String jarPath) Add the JAR resource into the classloader with specified session.
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.
org.apache.flink.table.api.TableResult	executeModifyOperations(String sessionId, List<org.apache.flink.table.operations.ModifyOperation> operations) Executes modify operations, and return TableResult as execution result.
org.apache.flink.table.api.TableResult	executeOperation(String sessionId, org.apache.flink.table.operations.Operation operation) Executes an operation, and return TableResult as execution result.
ResultDescriptor	executeQuery(String sessionId, org.apache.flink.table.operations.QueryOperation query) Submits a Flink SQL query job (detached) and returns the result descriptor.
org.apache.flink.configuration.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.
List<String>	listJars(String sessionId) List the JAR resources of the classloader with specified session.
String	openSession(String sessionId) Open a new session by using the given session id.
org.apache.flink.table.operations.Operation	parseStatement(String sessionId, String statement) Parse a SQL statement to Operation.
void	removeJar(String sessionId, String jarPath) 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<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.

方法详细资料

start

void start()
    throws SqlExecutionException

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

抛出:

SqlExecutionException

openSession

String openSession(@Nullable
                   String sessionId)
            throws SqlExecutionException

Open a new session by using the given session id.

参数:

sessionId - session identifier.

返回:

used session identifier to track the session.

抛出:

SqlExecutionException - if any error happen

closeSession

void closeSession(String sessionId)
           throws SqlExecutionException

Close the resources of session for given session id.

参数:

sessionId - session identifier

抛出:

SqlExecutionException - if any error happen

getSessionConfigMap

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

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

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

抛出:

SqlExecutionException

getSessionConfig

org.apache.flink.configuration.ReadableConfig getSessionConfig(String sessionId)
                                                        throws SqlExecutionException

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

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

抛出:

SqlExecutionException

resetSessionProperties

void resetSessionProperties(String sessionId)
                     throws SqlExecutionException

Reset all the properties for the given session identifier.

参数:

sessionId - to identifier the session

抛出:

SqlExecutionException - if any error happen.

resetSessionProperty

void resetSessionProperty(String sessionId,
                          String key)
                   throws SqlExecutionException

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

参数:

sessionId - to identifier the session

key - of need to reset the session property

抛出:

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.

参数:

key - of the session property

value - of the session property

抛出:

SqlExecutionException - if any error happen.

parseStatement

org.apache.flink.table.operations.Operation parseStatement(String sessionId,
                                                           String statement)
                                                    throws SqlExecutionException

Parse a SQL statement to Operation.

抛出:

SqlExecutionException

completeStatement

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

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

executeOperation

org.apache.flink.table.api.TableResult executeOperation(String sessionId,
                                                        org.apache.flink.table.operations.Operation operation)
                                                 throws SqlExecutionException

Executes an operation, and return TableResult as execution result.

抛出:

SqlExecutionException

executeModifyOperations

org.apache.flink.table.api.TableResult executeModifyOperations(String sessionId,
                                                               List<org.apache.flink.table.operations.ModifyOperation> operations)
                                                        throws SqlExecutionException

Executes modify operations, and return TableResult as execution result.

抛出:

SqlExecutionException

executeQuery

ResultDescriptor executeQuery(String sessionId,
                              org.apache.flink.table.operations.QueryOperation query)
                       throws SqlExecutionException

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

抛出:

SqlExecutionException

retrieveResultChanges

TypedResult<List<org.apache.flink.types.Row>> retrieveResultChanges(String sessionId,
                                                                    String resultId)
                                                             throws SqlExecutionException

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

抛出:

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.

抛出:

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.

抛出:

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.

抛出:

SqlExecutionException

addJar

void addJar(String sessionId,
            String jarPath)

Add the JAR resource into the classloader with specified session.

removeJar

void removeJar(String sessionId,
               String jarPath)

Remove the JAR resource from the classloader with specified session.

listJars

List<String> listJars(String sessionId)

List the JAR resources of the classloader with specified session.