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

类 LocalExecutor

java.lang.Object

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

所有已实现的接口:

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.

构造器概要

构造器

构造器和说明
LocalExecutor(DefaultContext defaultContext) Creates a local executor for submitting table programs and retrieving results.

方法概要

限定符和类型	方法和说明
void	addJar(String sessionId, String jarUrl) 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.
protected ExecutionContext	getExecutionContext(String sessionId) Get the existed ExecutionContext from contextMap, or thrown exception if does not exist.
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 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<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.

从类继承的方法 java.lang.Object

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

构造器详细资料

LocalExecutor

public LocalExecutor(DefaultContext defaultContext)

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

方法详细资料

start

public void start()

从接口复制的说明: Executor

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

指定者:

start 在接口中 Executor

openSession

public String openSession(@Nullable
                          String sessionId)
                   throws SqlExecutionException

从接口复制的说明: Executor

Open a new session by using the given session id.

指定者:

openSession 在接口中 Executor

参数:

sessionId - session identifier.

返回:

used session identifier to track the session.

抛出:

SqlExecutionException - if any error happen

closeSession

public void closeSession(String sessionId)
                  throws SqlExecutionException

从接口复制的说明: Executor

Close the resources of session for given session id.

指定者:

closeSession 在接口中 Executor

参数:

sessionId - session identifier

抛出:

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.

抛出:

SqlExecutionException

getSessionConfigMap

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

从接口复制的说明: 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.

指定者:

getSessionConfigMap 在接口中 Executor

抛出:

SqlExecutionException

getSessionConfig

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

从接口复制的说明: 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.

指定者:

getSessionConfig 在接口中 Executor

抛出:

SqlExecutionException

resetSessionProperties

public void resetSessionProperties(String sessionId)
                            throws SqlExecutionException

从接口复制的说明: Executor

Reset all the properties for the given session identifier.

指定者:

resetSessionProperties 在接口中 Executor

参数:

sessionId - to identifier the session

抛出:

SqlExecutionException - if any error happen.

resetSessionProperty

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

从接口复制的说明: Executor

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

指定者:

resetSessionProperty 在接口中 Executor

参数:

sessionId - to identifier the session

key - of need to reset the session property

抛出:

SqlExecutionException - if any error happen.

setSessionProperty

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

从接口复制的说明: Executor

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

指定者:

setSessionProperty 在接口中 Executor

key - of the session property

value - of the session property

抛出:

SqlExecutionException - if any error happen.

parseStatement

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

从接口复制的说明: Executor

Parse a SQL statement to Operation.

指定者:

parseStatement 在接口中 Executor

抛出:

SqlExecutionException

completeStatement

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

从接口复制的说明: Executor

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

指定者:

completeStatement 在接口中 Executor

executeOperation

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

从接口复制的说明: Executor

Executes an operation, and return TableResult as execution result.

指定者:

executeOperation 在接口中 Executor

抛出:

SqlExecutionException

executeModifyOperations

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

从接口复制的说明: Executor

Executes modify operations, and return TableResult as execution result.

指定者:

executeModifyOperations 在接口中 Executor

抛出:

SqlExecutionException

executeQuery

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

从接口复制的说明: Executor

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

指定者:

executeQuery 在接口中 Executor

抛出:

SqlExecutionException

retrieveResultChanges

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

从接口复制的说明: Executor

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

指定者:

retrieveResultChanges 在接口中 Executor

抛出:

SqlExecutionException

snapshotResult

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

从接口复制的说明: 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.

指定者:

snapshotResult 在接口中 Executor

抛出:

SqlExecutionException

retrieveResultPage

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

从接口复制的说明: Executor

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

指定者:

retrieveResultPage 在接口中 Executor

抛出:

SqlExecutionException

cancelQuery

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

从接口复制的说明: Executor

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

指定者:

cancelQuery 在接口中 Executor

抛出:

SqlExecutionException

addJar

public void addJar(String sessionId,
                   String jarUrl)

从接口复制的说明: Executor

Add the JAR resource into the classloader with specified session.

指定者:

addJar 在接口中 Executor

removeJar

public void removeJar(String sessionId,
                      String jarUrl)

从接口复制的说明: Executor

Remove the JAR resource from the classloader with specified session.

指定者:

removeJar 在接口中 Executor

listJars

public List<String> listJars(String sessionId)

从接口复制的说明: Executor

List the JAR resources of the classloader with specified session.

指定者:

listJars 在接口中 Executor