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

方法概要

限定符和类型	方法和说明
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.
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.
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 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.
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.

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

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

构造器详细资料

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.

方法详细资料

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

从接口复制的说明: Executor

Open a new session by using the given SessionContext.

指定者:

openSession 在接口中 Executor

参数:

sessionContext - context to create new session.

返回:

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

getSessionProperties

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

从接口复制的说明: Executor

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

指定者:

getSessionProperties 在接口中 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.

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.

listCatalogs

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

从接口复制的说明: Executor

Lists all registered catalogs.

指定者:

listCatalogs 在接口中 Executor

抛出:

SqlExecutionException

listDatabases

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

从接口复制的说明: Executor

Lists all databases in the current catalog.

指定者:

listDatabases 在接口中 Executor

抛出:

SqlExecutionException

createTable

public void createTable(String sessionId,
                        String ddl)
                 throws SqlExecutionException

从接口复制的说明: Executor

Create a table with a DDL statement.

指定者:

createTable 在接口中 Executor

抛出:

SqlExecutionException

dropTable

public void dropTable(String sessionId,
                      String ddl)
               throws SqlExecutionException

从接口复制的说明: Executor

Drop a table with a DDL statement.

指定者:

dropTable 在接口中 Executor

抛出:

SqlExecutionException

listTables

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

从接口复制的说明: Executor

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

指定者:

listTables 在接口中 Executor

抛出:

SqlExecutionException

listUserDefinedFunctions

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

从接口复制的说明: Executor

Lists all user-defined functions known to the executor.

指定者:

listUserDefinedFunctions 在接口中 Executor

抛出:

SqlExecutionException

executeSql

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

从接口复制的说明: Executor

Executes a SQL statement.

指定者:

executeSql 在接口中 Executor

抛出:

SqlExecutionException

listFunctions

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

从接口复制的说明: Executor

Lists all functions known to the executor.

指定者:

listFunctions 在接口中 Executor

抛出:

SqlExecutionException

listModules

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

从接口复制的说明: Executor

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

指定者:

listModules 在接口中 Executor

抛出:

SqlExecutionException

useCatalog

public void useCatalog(String sessionId,
                       String catalogName)
                throws SqlExecutionException

从接口复制的说明: Executor

Sets a catalog with given name as the current catalog.

指定者:

useCatalog 在接口中 Executor

抛出:

SqlExecutionException

useDatabase

public void useDatabase(String sessionId,
                        String databaseName)
                 throws SqlExecutionException

从接口复制的说明: Executor

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

指定者:

useDatabase 在接口中 Executor

抛出:

SqlExecutionException

getTableSchema

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

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

指定者:

getTableSchema 在接口中 Executor

抛出:

SqlExecutionException

getSqlParser

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

从接口复制的说明: Executor

Returns a sql parser instance.

指定者:

getSqlParser 在接口中 Executor

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

executeQuery

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

executeUpdate

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

从接口复制的说明: Executor

Submits a Flink SQL update statement such as INSERT INTO.

指定者:

executeUpdate 在接口中 Executor

参数:

sessionId - to identify the user session.

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

返回:

information about the target of the submitted Flink job

抛出:

SqlExecutionException