org.teiid.translator

Interface ExecutionContext

All Known Implementing Classes:

ExecutionContextImpl

public interface ExecutionContext

The security context provides information about the user context in which this query is being run. As of 4.2, the SecurityContext is a sub-interface of ExecutionContext such that both interfaces contain all of the methods from the prior independent interfaces. Thus, these interfaces can now be used interchangeably.

Method Summary

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. see getConnectionId()
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 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.

Method Detail

getConnectorIdentifier

String getConnectorIdentifier()

Get the identifier for the current connector running the command

Returns:

Connector identifier; never null

getRequestId

String getRequestId()

Get the identifier for the command being executed. This can be correlated back to identifiers exposed in other parts of the system. shortcut for getCommandContext().getRequestId()

Returns:

command identifier

getRequestID

String getRequestID()

Deprecated. see getRequestId()

Returns:

getPartIdentifier

String getPartIdentifier()

This specifies the node id for the atomic request in the relational plan of query.

getExecutionCountIdentifier

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.

getVdbName

String getVdbName()

Get the name of the VDB this query is being run against. shortcut for getCommandContext().getVdbName()

Returns:

VDB name, never null

getVdbVersion

String getVdbVersion()

Get the version of the VDB this query is being run against. shortcut for getCommandContext().getVdbVersion()

Returns:

VDB version

getSubject

Subject getSubject()

Get the user for the user running this query.

Returns:

User, never null

getCommandPayload

Serializable getCommandPayload()

Get the command payload shortcut for getCommandContext().getCommandPayload()

Returns:

the payload or null if one was not set by the client

getExecutionPayload

Serializable getExecutionPayload()

Deprecated. see getCommandPayload()

Returns:

getGeneralHint

String getGeneralHint()

Get the collection of general hints as a space concatenated string.

Returns:

the general hint or null if none was specified

getSourceHint

String getSourceHint()

Get the collection of hints designated for this source as a space concatenated string.

Returns:

the source hint or null if none was specified

getGeneralHints

Collection<String> getGeneralHints()

Get the general hints.

Returns:

the general hint or null if none was specified

getSourceHints

Collection<String> getSourceHints()

Get the hints designated for this source.

Returns:

the source hint or null if none was specified

getConnectionId

String getConnectionId()

Get the identifier for the connection through which the command is being executed. This represents the original user connection to the Teiid system shortcut for getCommandContext().getConnectionId()

Returns:

Connection identifier

getConnectionID

String getConnectionID()

Deprecated. see getConnectionId()

Returns:

keepExecutionAlive

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. It will only be closed at end of the user query.

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.

Parameters:

alive -

getBatchSize

int getBatchSize()

Return the current connector batch size. This may be used as a hint to the underlying source query.

Returns:

the Connector batch size.

addWarning

void addWarning(Exception ex)

Add an exception as a warning to this Execution. The exception will be wrapped by a TeiidSQLWarning for the client. The warnings can be consumed through the Statement.getWarnings() method.

Parameters:

ex -

isTransactional

boolean isTransactional()

Flag indicates that the operation needs to be executed in a XA transaction.

Returns:

getSession

Session getSession()

Get the current session. shortcut for getCommandContext().getSession()

Returns:

dataAvailable

void dataAvailable()

Signal the engine that data is available and processing should be resumed.

getCommandContext

CommandContext getCommandContext()

Get the CommandContext

Returns:

getCacheDirective

CacheDirective getCacheDirective()

Get the CacheDirective

Returns:

getRuntimeMetadata

RuntimeMetadata getRuntimeMetadata()

Returns:

the RuntimeMetadata

logCommand

void logCommand(Object... command)

Log the source command to the command log

Parameters:

command -

getScope

CacheDirective.Scope getScope()

Get the result cache scope for the current execution

Returns:

setScope

void setScope(CacheDirective.Scope scope)

Set the result cache scope for the current execution.
Setting to CacheDirective.Scope.NONE will typically result in the user query result being cached at the CacheDirective.Scope.SESSION level.

Parameters:

scope -