public interface Executor
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.
|
TableResultInternal |
executeModifyOperations(String sessionId,
List<ModifyOperation> operations)
Executes modify operations, and return
TableResult as execution result. |
TableResultInternal |
executeOperation(String sessionId,
Operation operation)
Executes an operation, and return
TableResult as execution result. |
ResultDescriptor |
executeQuery(String sessionId,
QueryOperation query)
Submits a Flink SQL query job (detached) and returns the result descriptor.
|
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. |
String |
openSession(String sessionId)
Open a new session by using the given session id.
|
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<RowData>> |
retrieveResultChanges(String sessionId,
String resultId)
Asks for the next changelog results (non-blocking).
|
List<RowData> |
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 start() throws SqlExecutionException
SqlExecutionException
String openSession(@Nullable String sessionId) throws SqlExecutionException
sessionId
- session identifier.SqlExecutionException
- if any error happenvoid closeSession(String sessionId) throws SqlExecutionException
sessionId
- session identifierSqlExecutionException
- if any error happenMap<String,String> getSessionConfigMap(String sessionId) throws SqlExecutionException
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
ReadableConfig getSessionConfig(String sessionId) throws SqlExecutionException
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
void resetSessionProperties(String sessionId) throws SqlExecutionException
sessionId
- to identifier the sessionSqlExecutionException
- if any error happen.void resetSessionProperty(String sessionId, String key) throws SqlExecutionException
sessionId
- to identifier the sessionkey
- of need to reset the session propertySqlExecutionException
- if any error happen.void setSessionProperty(String sessionId, String key, String value) throws SqlExecutionException
key
- of the session propertyvalue
- of the session propertySqlExecutionException
- if any error happen.Operation parseStatement(String sessionId, String statement) throws SqlExecutionException
Operation
.SqlExecutionException
List<String> completeStatement(String sessionId, String statement, int position)
TableResultInternal executeOperation(String sessionId, Operation operation) throws SqlExecutionException
TableResult
as execution result.SqlExecutionException
TableResultInternal executeModifyOperations(String sessionId, List<ModifyOperation> operations) throws SqlExecutionException
TableResult
as execution result.SqlExecutionException
ResultDescriptor executeQuery(String sessionId, QueryOperation query) throws SqlExecutionException
SqlExecutionException
TypedResult<List<RowData>> retrieveResultChanges(String sessionId, String resultId) throws SqlExecutionException
SqlExecutionException
TypedResult<Integer> snapshotResult(String sessionId, String resultId, int pageSize) throws SqlExecutionException
SqlExecutionException
List<RowData> retrieveResultPage(String resultId, int page) throws SqlExecutionException
SqlExecutionException
void cancelQuery(String sessionId, String resultId) throws SqlExecutionException
SqlExecutionException
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.