DSIExtDataEngineContext Class Reference

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

Inherits Simba::DSI::IMemoryContext.

List of all members.

Public Member Functions

void AddParameter (AEParameter *in_parameter)
 Add a parameter to the stored list.
 DSIExtDataEngineContext (Simba::DSI::IStatement *in_statement, Simba::SQLEngine::DSIExtSqlDataEngine *in_dataEngine)
 Constructor.
virtual
DSIExtCustomBehaviorProvider
GetCustomBehaviorProvider ()
 Get the DSIExtCustomBehaviorProvider.
Simba::SQLEngine::DSIExtSqlDataEngineGetDataEngine ()
 Get the DataEngine that created this context.
const std::vector< AEParameter * > & GetDefaultParameters ()
 Get the list of default parameters in the AETree.
const std::vector< AEParameter * > & GetNonDefaultParameters ()
 Get the list of non-default parameters in the AETree.
std::vector< AEParameter * > & GetParameters ()
 Get the list of parameters in the AETree.
const AttributeDataGetProperty (DSIExtDataEnginePropertyKey in_key) const
 Returns a data engine property corresponding to in_key.
const AttributeDataGetProperty (Simba::DSI::DSIStmtPropertyKey in_key) const
 Returns a statement property corresponding to in_key.
const AttributeDataGetProperty (Simba::DSI::DSIConnPropertyKey in_key) const
 Returns a connection property corresponding to in_key.
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.
const std::vector
< AENamedRelationalExpr * > & 
GetReferencedNamedRelations (AEStatement *in_root)
 Get a list of tables referenced in the query.
const std::vector< AETable * > & GetReferencedTables (AEStatement *in_root)
 Get a list of tables referenced in the query.
SqlCDataPoolGetSqlCDataPool () const
 Get the SqlCDataPool for this connection.
SqlConverterFactoryGetSqlConverterFactory () const
 Get the SqlConverterFactory for this connection.
SqlDataFactoryGetSqlDataFactory () const
 Get the SqlDataFactory for this connection.
SqlDataTypeUtilitiesGetSqlDataTypeUtilities ()
simba_int16 GetSqlTypeForTypeName (const simba_wstring &in_typeName)
 Return the SQL type associated with the string.
IWarningListenerGetWarningListener ()
 Get the warning listener associated with this context.
virtual const volatile bool & IsCanceled () const
 Determines if the cancel has been called on the requester.
bool IsDriverUnicode ()
 Get whether the driver is UNICODE-encoded or ANSI-encoded.
bool IsEmptyStringNull ()
 Get whether the data engine should treat the empty string as equivalent to NULL data.
void SetIsCanceled (bool in_isCanceled)
 Set if execution has been canceled.

Friends

class SharedPtr< DSIExtDataEngineContext >

Detailed Description

A class representing the "context" that a DSIExtSqlDataEngine object relies on for SQL statement preparation.


Constructor & Destructor Documentation

Constructor.

Parameters:
in_statement The statement holding the DSI properties. (NOT OWN)
in_dataEngine The DataEngine that created this context. (NOT OWN)
Exceptions:
SEInvalidArgumentException when in_statement is NULL

Member Function Documentation

void AddParameter ( AEParameter in_parameter  ) 

Add a parameter to the stored list.

Parameters:
in_parameter The AETree parameter. (NOT OWN)
virtual DSIExtCustomBehaviorProvider* GetCustomBehaviorProvider (  )  [virtual]

Get the DSIExtCustomBehaviorProvider.

Returns:
The DSIExtCustomBehaviorProvider to use for handling custom behavior. (NOT OWN)
Simba::SQLEngine::DSIExtSqlDataEngine* GetDataEngine (  ) 

Get the DataEngine that created this context.

Returns:
the DataEngine that created this context. (NOT OWN)
const std::vector<AEParameter*>& GetDefaultParameters (  ) 

Get the list of default parameters in the AETree.

Returns:
The list of default parameters in the AETree. (NOT OWN)
const std::vector<AEParameter*>& GetNonDefaultParameters (  ) 

Get the list of non-default parameters in the AETree.

Returns:
The list of non-default parameters in the AETree. (NOT OWN)
std::vector<AEParameter*>& GetParameters (  ) 

Get the list of parameters in the AETree.

Returns:
the parameters in the AETree. (NOT OWN)
const AttributeData* GetProperty ( DSIExtDataEnginePropertyKey  in_key  )  const

Returns a data engine property corresponding to in_key.

Please refer to DSIExtDataEngineProperties.h for detailed information on the supported properties.

Parameters:
in_key The data engine property key for the property to retrieve.
Returns:
the data engine property value for the given key. (NOT OWN)
const AttributeData* GetProperty ( Simba::DSI::DSIStmtPropertyKey  in_key  )  const

Returns a statement property corresponding to in_key.

Please refer to the DSI Design and Implementation Guide for detailed information on the supported properties.

Parameters:
in_key The statement property key for the property to retrieve.
Returns:
the statement property value for the given key. (NOT OWN)
const AttributeData* GetProperty ( Simba::DSI::DSIConnPropertyKey  in_key  )  const

Returns a connection property corresponding to in_key.

Please refer to the DSI Design and Implementation Guide for detailed information on the supported properties.

Parameters:
in_key The connection property key for the property to retrieve.
Returns:
the connection property value for the given key. (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 unique ID for this memory context.

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.

const std::vector<AENamedRelationalExpr*>& GetReferencedNamedRelations ( AEStatement in_root  ) 

Get a list of tables referenced in the query.

Parameters:
in_root The root node. (NOT OWN)
Returns:
The list of referenced tables. (NOT OWN)
const std::vector<AETable*>& GetReferencedTables ( AEStatement in_root  ) 

Get a list of tables referenced in the query.

Parameters:
in_root The root node. (NOT OWN)
Returns:
The list of referenced tables. (NOT OWN)
SqlCDataPool& GetSqlCDataPool (  )  const

Get the SqlCDataPool for this connection.

SqlConverterFactory& GetSqlConverterFactory (  )  const

Get the SqlConverterFactory for this connection.

SqlDataFactory& GetSqlDataFactory (  )  const

Get the SqlDataFactory for this connection.

SqlDataTypeUtilities& GetSqlDataTypeUtilities (  ) 
Returns:
SQL Data Type utilities for this connection.
simba_int16 GetSqlTypeForTypeName ( const simba_wstring in_typeName  ) 

Return the SQL type associated with the string.

This is a case-insensitive comparison. If no type is found, SQL_UNKNOWN_TYPE is returned.

Parameters:
in_typeName The name of the data type.
Returns:
The SQL type associated with in_typeName, or SQL_UNKNOWN_TYPE.
IWarningListener* GetWarningListener (  ) 

Get the warning listener associated with this context.

Returns:
the warning listener associated with this context. (NOT OWN)
virtual const volatile bool& IsCanceled (  )  const [virtual]

Determines if the cancel has been called on the requester.

Returns:
A reference to the canceled flag.

Implements IMemoryContext.

bool IsDriverUnicode (  ) 

Get whether the driver is UNICODE-encoded or ANSI-encoded.

This value is based on the value for the SQL_ATTR_ANSI_APP connection attribute. This attribute is mapped to the DSI_CONN_ANSI_APP connection attribute.

If the driver is UNICODE-encoded, then character string literals will be SQL_WCHAR- typed. Otherwise, they will be SQL_CHAR-typed.

Returns:
True if the driver is UNICODE-encoded; false if it is ANSI-encoded.
bool IsEmptyStringNull (  ) 

Get whether the data engine should treat the empty string as equivalent to NULL data.

Returns:
True if the data engine should treat the empty string as equivalent to NULL data, false otherwise.
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 SharedPtr< DSIExtDataEngineContext > [friend]

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