public interface ExecutionContext
Modifier and Type | Method and Description |
---|---|
void |
addWarning(Exception ex)
Add an exception as a warning to this Execution.
|
void |
dataAvailable()
Signal the engine that data is available and processing should be
resumed.
|
int |
getBatchSize()
Return the current connector batch size.
|
CacheDirective |
getCacheDirective()
Get the
CacheDirective |
CommandContext |
getCommandContext()
Get the CommandContext
|
Serializable |
getCommandPayload()
Get the command payload
shortcut for
getCommandContext() .getCommandPayload() |
String |
getConnectionId()
Get the identifier for the connection through which
the command is being executed.
|
String |
getConnectionID()
Deprecated.
|
String |
getConnectorIdentifier()
Get the identifier for the current connector running the command
|
String |
getExecutionCountIdentifier()
Execution count defines an id; where every access to the connector from
the server in a given command execution boundary is uniquely defined;
Like for example in the case of "batched execution" of commands, each execution of
command gets new identifier.
|
Serializable |
getExecutionPayload()
Deprecated.
see {@link #getCommandPayload()
|
String |
getGeneralHint()
Get the collection of general hints as a space concatenated string.
|
Collection<String> |
getGeneralHints()
Get the general hints.
|
String |
getPartIdentifier()
This specifies the node id for the atomic request in the relational plan of query.
|
String |
getRequestId()
Get the identifier for the command being executed.
|
String |
getRequestID()
Deprecated.
see
getRequestId() |
RuntimeMetadata |
getRuntimeMetadata() |
CacheDirective.Scope |
getScope()
Get the result cache scope for the current execution
|
Session |
getSession()
Get the current session.
|
String |
getSourceHint()
Get the collection of hints designated for this source as a space concatenated string.
|
Collection<String> |
getSourceHints()
Get the hints designated for this source.
|
Subject |
getSubject()
Get the user for the user running this query.
|
String |
getVdbName()
Get the name of the VDB this query is being run against.
|
String |
getVdbVersion()
Get the version of the VDB this query is being run against.
|
boolean |
isTransactional()
Flag indicates that the operation needs to be executed in a XA transaction.
|
void |
keepExecutionAlive(boolean alive)
When the execution is turned on with "alive=true", the execution object will not
be implicitly closed at the end of the last batch.
|
void |
logCommand(Object... command)
Log the source command to the command log
|
void |
setScope(CacheDirective.Scope scope)
Set the result cache scope for the current execution.
|
String getConnectorIdentifier()
String getRequestId()
getCommandContext()
.getRequestId()String getRequestID()
getRequestId()
String getPartIdentifier()
String getExecutionCountIdentifier()
String getVdbName()
getCommandContext()
.getVdbName()String getVdbVersion()
getCommandContext()
.getVdbVersion()Subject getSubject()
Serializable getCommandPayload()
getCommandContext()
.getCommandPayload()Serializable getExecutionPayload()
String getGeneralHint()
String getSourceHint()
Collection<String> getGeneralHints()
Collection<String> getSourceHints()
String getConnectionId()
getCommandContext()
.getConnectionId()String getConnectionID()
getConnectionId()
void keepExecutionAlive(boolean alive)
The engine will already detect situations when the connection should stay open for LOB (clob/blob/xml) streaming.
Keeping the execution alive unnecessarily may cause issues with connection usage as the connection instance may not be usable by other queries.
alive
- int getBatchSize()
void addWarning(Exception ex)
TeiidSQLWarning
for the client.
The warnings can be consumed through the Statement.getWarnings()
method.ex
- boolean isTransactional()
Session getSession()
getCommandContext()
.getSession()void dataAvailable()
CommandContext getCommandContext()
CacheDirective getCacheDirective()
CacheDirective
RuntimeMetadata getRuntimeMetadata()
RuntimeMetadata
void logCommand(Object... command)
command
- CacheDirective.Scope getScope()
void setScope(CacheDirective.Scope scope)
CacheDirective.Scope.NONE
will typically result in the user query result being
cached at the CacheDirective.Scope.SESSION
level.scope
- Copyright © 2017 JBoss by Red Hat. All rights reserved.