public interface Executor
Modifier and Type | Method and Description |
---|---|
void |
addView(String sessionId,
String name,
String query)
Add a new view to the given 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.
|
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.
|
ProgramTargetDescriptor |
executeUpdate(String sessionId,
String statement)
Submits a Flink SQL update statement such as INSERT INTO.
|
String |
explainStatement(String sessionId,
String statement)
Returns a string-based explanation about AST and execution plan of the given statement.
|
Map<String,String> |
getSessionProperties(String sessionId)
Lists all session properties that are defined by the executor and the session.
|
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.
|
Map<String,ViewEntry> |
listViews(String sessionId)
Lists all registered views for the given session.
|
String |
openSession(SessionContext session)
Open a new session by using the given
SessionContext . |
void |
removeView(String sessionId,
String name)
Remove the view with given name for the given session.
|
void |
resetSessionProperties(String sessionId)
Reset all the properties for the given session identifier.
|
TypedResult<List<Tuple2<Boolean,Row>>> |
retrieveResultChanges(String sessionId,
String resultId)
Asks for the next changelog results (non-blocking).
|
List<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.
|
void start() throws SqlExecutionException
SqlExecutionException
String openSession(SessionContext session) throws SqlExecutionException
SessionContext
.session
- context to create new session.SqlExecutionException
- if any error happenvoid closeSession(String sessionId) throws SqlExecutionException
sessionId
- session identifierSqlExecutionException
- if any error happenMap<String,String> getSessionProperties(String sessionId) throws SqlExecutionException
SqlExecutionException
void resetSessionProperties(String sessionId) throws SqlExecutionException
sessionId
- to identifier the sessionSqlExecutionException
- 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.void addView(String sessionId, String name, String query) throws SqlExecutionException
sessionId
- to identify the session.name
- of the view.query
- to represent the view.SqlExecutionException
void removeView(String sessionId, String name) throws SqlExecutionException
sessionId
- to identify the session.name
- of the view.SqlExecutionException
Map<String,ViewEntry> listViews(String sessionId) throws SqlExecutionException
sessionId
- to identify the session.SqlExecutionException
List<String> listCatalogs(String sessionid) throws SqlExecutionException
SqlExecutionException
List<String> listDatabases(String sessionId) throws SqlExecutionException
SqlExecutionException
void createTable(String sessionId, String ddl) throws SqlExecutionException
SqlExecutionException
void dropTable(String sessionId, String ddl) throws SqlExecutionException
SqlExecutionException
List<String> listTables(String sessionId) throws SqlExecutionException
SqlExecutionException
List<String> listUserDefinedFunctions(String sessionId) throws SqlExecutionException
SqlExecutionException
List<String> listFunctions(String sessionId) throws SqlExecutionException
SqlExecutionException
List<String> listModules(String sessionId) throws SqlExecutionException
SqlExecutionException
void useCatalog(String sessionId, String catalogName) throws SqlExecutionException
SqlExecutionException
void useDatabase(String sessionId, String databaseName) throws SqlExecutionException
SqlExecutionException
TableSchema getTableSchema(String sessionId, String name) throws SqlExecutionException
SqlExecutionException
String explainStatement(String sessionId, String statement) throws SqlExecutionException
SqlExecutionException
List<String> completeStatement(String sessionId, String statement, int position)
ResultDescriptor executeQuery(String sessionId, String query) throws SqlExecutionException
SqlExecutionException
TypedResult<List<Tuple2<Boolean,Row>>> retrieveResultChanges(String sessionId, String resultId) throws SqlExecutionException
SqlExecutionException
TypedResult<Integer> snapshotResult(String sessionId, String resultId, int pageSize) throws SqlExecutionException
SqlExecutionException
List<Row> retrieveResultPage(String resultId, int page) throws SqlExecutionException
SqlExecutionException
void cancelQuery(String sessionId, String resultId) throws SqlExecutionException
SqlExecutionException
ProgramTargetDescriptor executeUpdate(String sessionId, String statement) throws SqlExecutionException
sessionId
- to identify the user session.statement
- SQL update statement (currently only INSERT INTO is supported)SqlExecutionException
Copyright © 2014–2020 The Apache Software Foundation. All rights reserved.