IDataEngine Class Reference

This class exposes an interface for SimbaLib to interact with the customer DSII for DataEngine details. More...

Inherited by DSIDataEngine.

List of all members.

Public Member Functions

virtual Simba::DSI::IResultMakeNewMetadataResult (Simba::DSI::DSIMetadataTableID in_metadataTableID, const std::vector< Variant > &in_filterValues, const simba_wstring &in_escapeChar, const simba_wstring &in_identifierQuoteChar, bool in_filterAsIdentifier)=0
 Creates a new IResult* which contains a metadata data source and filters to filter out rows in the metadata table that are not needed.
virtual
Simba::DSI::IQueryExecutor
Prepare (const simba_wstring &in_sqlQuery)=0
 Prepares the given SQL-string for execution and returns on object representing the prepared query.
virtual void SetDirectExecute ()=0
 Indicate that any queries prepared by this data engine will be executed immediately, and only once.
virtual ~IDataEngine ()
 Destructor.

Protected Member Functions

 IDataEngine ()
 Constructor.

Detailed Description

This class exposes an interface for SimbaLib to interact with the customer DSII for DataEngine details.


Constructor & Destructor Documentation

virtual ~IDataEngine (  )  [inline, virtual]

Destructor.

IDataEngine (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual Simba::DSI::IResult* MakeNewMetadataResult ( Simba::DSI::DSIMetadataTableID  in_metadataTableID,
const std::vector< Variant > &  in_filterValues,
const simba_wstring in_escapeChar,
const simba_wstring in_identifierQuoteChar,
bool  in_filterAsIdentifier 
) [pure virtual]

Creates a new IResult* which contains a metadata data source and filters to filter out rows in the metadata table that are not needed.

Parameters:
in_metadataTableID Identifier to create the appropriate metadata table.
in_filterValues Filters to be applied to the metadata table. These filters are passed in by the application that calls the catalog function and cannot be modified. For example, the catalog function "SQLTables" contains the arguments "CatalogName", "SchemaName", "TableName", and "TableType". These arguments are extracted to the in_filterValues vector. While these values cannot be modified, if the CatalogName is NULL, the current catalog name is used.
in_escapeChar Escape character used in filtering.
in_identifierQuoteChar Quote identifier, which is the quotation mark that this filter recognizes.
in_filterAsIdentifier Indicates if string filters are treated as identifiers. If in_metadataID is true, string filters are treated as identifiers. Otherwise, filters are not treated as identifiers.
Returns:
IResult reference that contains a metadata data source and filters rows not needed. (OWN)

Implemented in DSIDataEngine.

virtual Simba::DSI::IQueryExecutor* Prepare ( const simba_wstring in_sqlQuery  )  [pure virtual]

Prepares the given SQL-string for execution and returns on object representing the prepared query.

An IQueryExecutor is returned, which will be used to handle query execution. The provided SQL-string will already have been converted to the underlying datasource's native syntax if the IDriver property DSI_DRIVER_NATIVE_SQL_BEFORE_PREPARE is set to DSI_PROP_TRUE (DSI_PROP_FALSE is the default), otherwise this function will need to convert to the native syntax.

The new IQueryExecutor will contain an IResults* upon construction, which itself contains one or more IResult* objects, describing the results of the query. After prepare, but before execution, these IResult objects should be able to describe the columns in the result, although the metadata may not be accurate until after execution.

Otherwise, an appropriate exception may be thrown indicating an error with the query.

Parameters:
in_sqlQuery The SQL string to prepare.
Returns:
A new IQueryExecutor that is used to handle query execution. (OWN)

Implemented in DSIExtSqlDataEngine.

virtual void SetDirectExecute (  )  [pure virtual]

Indicate that any queries prepared by this data engine will be executed immediately, and only once.

If this function is not called, then the prepared query may be executed multiple times.

Implemented in DSIDataEngine.


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

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