DSIExtExecutorContext Class Reference

A class representing the "context" that a DSIExtQueryExecutor object relies on for SQL statement execution. More...

Inherits Simba::DSI::IMemoryContext.

List of all members.

Public Member Functions

 DSIExtExecutorContext (SharedPtr< Simba::SQLEngine::DSIExtDataEngineContext > in_dataEngineCtx, Simba::SQLEngine::DSIExtQueryExecutor *in_executor)
 Constructor.
AEStatementGetCurrentlyMaterializingStatement ()
 Get a pointer to the AEStatement which is currently in the process of being materialized.
Simba::SQLEngine::DSIExtDataEngineContextGetDataEngineContext ()
 Retrieves a reference to the data engine context.
Simba::SQLEngine::DSIExtQueryExecutorGetExecutor ()
 Retrieves a reference to the executor.
const Simba::DSI::IMemoryContextGetMemoryContext () const
Simba::SQLEngine::DSIExtOperationHandlerFactoryGetOperationHandlerFactory ()
 Retrieves a reference to the operation handler factory.
Simba::SQLEngine::DSIExtPassdownInformationGetPassdownInformation ()
 Retrieves a reference to the passdown information.
virtual Simba::DSI::MemoryToken GetQuerySpecificID () const
 Provides a unique ID for the memory manager to identify different consumers that come from the same query.
virtual simba_uint32 GetQueryTimeOut () const
 Returns the time-out value, the query will wait max time-out value on memory and then it throws a memory error if it cannot reserve the requested memory.
IWarningListenerGetWarningListener ()
 Retrieve a reference to the warning listener.
const volatile bool & IsCanceled () const
 Retrieve a reference to a flag indicating if execution has been canceled.
void SetCurrentlyMaterializingStatement (AEStatement *in_statement)
 Set the AEStatement which is currently being materialized onto the context.
void SetIsCanceled (bool in_isCanceled)
 Set if execution has been canceled.
virtual ~DSIExtExecutorContext ()
 Destructor.

Friends

class DSIExtQueryExecutor
 Friends.

Detailed Description

A class representing the "context" that a DSIExtQueryExecutor object relies on for SQL statement execution.


Constructor & Destructor Documentation

Constructor.

Parameters:
in_dataEngineCtx Reference to the context for the data engine. (NOT OWN)
in_executor Reference to the executor which creates and holds this context object. (NOT OWN)
Exceptions:
SEInvalidArgumentException when in_statement is NULL.
virtual ~DSIExtExecutorContext (  )  [virtual]

Destructor.


Member Function Documentation

AEStatement* GetCurrentlyMaterializingStatement (  ) 

Get a pointer to the AEStatement which is currently in the process of being materialized.

Returns:
A pointer to the AEStatement which is currently in the process of being materialized. NULL if there is no such AEStatement.
Simba::SQLEngine::DSIExtDataEngineContext* GetDataEngineContext (  ) 

Retrieves a reference to the data engine context.

Returns:
A reference to the data engine context. (NOT OWN)

Retrieves a reference to the executor.

Returns:
A reference to the executor. (NOT OWN)
const Simba::DSI::IMemoryContext& GetMemoryContext (  )  const
Simba::SQLEngine::DSIExtOperationHandlerFactory* GetOperationHandlerFactory (  ) 

Retrieves a reference to the operation handler factory.

Returns:
A reference to the operation handler factory. (NOT OWN)
Simba::SQLEngine::DSIExtPassdownInformation* GetPassdownInformation (  ) 

Retrieves a reference to the passdown information.

Returns:
A reference to the passdown information. (NOT OWN)
virtual Simba::DSI::MemoryToken GetQuerySpecificID (  )  const [virtual]

Provides a unique ID for the memory manager to identify different consumers that come from the same query.

Returns:
A query specific unique ID

Implements IMemoryContext.

virtual simba_uint32 GetQueryTimeOut (  )  const [virtual]

Returns the time-out value, the query will wait max time-out value on memory and then it throws a memory error if it cannot reserve the requested memory.

Returns:
The time out value in milliseconds.

Implements IMemoryContext.

IWarningListener* GetWarningListener (  ) 

Retrieve a reference to the warning listener.

Returns:
A reference to the warning listener. (NOT OWN)
const volatile bool& IsCanceled (  )  const [virtual]

Retrieve a reference to a flag indicating if execution has been canceled.

Returns:
A reference to a flag that is true if execution is canceled; false otherwise.

Implements IMemoryContext.

void SetCurrentlyMaterializingStatement ( AEStatement in_statement  ) 

Set the AEStatement which is currently being materialized onto the context.

Parameters:
in_statement The AEStatement which is currently being materialized. Should be set to NULL after its materialization completes. (NOT OWN)
Exceptions:
SEInvalidArgumentException If the currently materializing statement on this object is non-NULL, and something other than NULL is passed in.
void SetIsCanceled ( bool  in_isCanceled  ) 

Set if execution has been canceled.

Parameters:
in_isCanceled True if execution is canceled; false otherwise.

Friends And Related Function Documentation

friend class DSIExtQueryExecutor [friend]

Friends.


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:17 2017 for SimbaEngine 10.1.3.1011 by simba