Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

wx::DBI::StatementCache Class Reference

#include <dbi.h>

Collaboration diagram for wx::DBI::StatementCache:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 StatementCache (Database *pdbNew)
virtual ~StatementCache ()
virtual void CacheExecute (const wxString &sName, const wxString &sQuery, const ArrayRecord &arParameters=ArrayRecord())
 Prepare, cache and execute a query without returning a result.

virtual void CacheExecute (const wxString &sName, const wxString &sQuery, const ArrayRecord &arParameters, wxVariant &v)
 Prepare, cache and execute a query returning the first field of the first result.

virtual void CacheExecute (const wxString &sName, const wxString &sQuery, const ArrayRecord &arParameters, ArrayRecord &arResult)
 Prepare, cache and execute a query returning an ArrayRecord.

virtual void CacheExecute (const wxString &sName, const wxString &sQuery, const ArrayRecord &arParameters, HashRecord &hrResult)
 Prepare, cache and execute a query returning an HashRecord.

virtual void CacheExecute (const wxString &sName, const wxString &sQuery, const ArrayRecord &arParameters, ArrayRecordArray &araResult)
 Prepare, cache and execute a query returning an ArrayRecordArray.

virtual void CacheExecute (const wxString &sName, const wxString &sQuery, const ArrayRecord &arParameters, HashRecordArray &hraResult)
 Prepare, cache and execute a query returning an HashRecordArray.

virtual void CacheExecuteInsert (const wxString &sName, const wxString &sQuery, const ArrayRecord &arParameters, long &nLastInsertId)
 Prepare, cache and execute a query returning the new id.

virtual void ExecuteTemporary (const wxString &sQuery, const ArrayRecord &arParameters=ArrayRecord())
 Execute a query.

virtual void ExecuteTemporary (const wxString &sQuery, const ArrayRecord &arParameters, ArrayRecordArray &araResult)
 Execute a query.

virtual void Clear ()

Protected Attributes

Cache cch
Database * pdb

Private Types

typedef std::map< wxString,
Statement * > 		Cache

Private Member Functions

 StatementCache ()
Statement * HandleCaching (const wxString &sName, const wxString &sQuery)
void Delete (const wxString &sName)
 Delete a query from the cache.

bool Exists (const wxString &sName)
 Cehck if a query exists in the cache.

Member Typedef Documentation

typedef std::map<wxString, Statement *> wx::DBI::StatementCache::Cache [private]
 

Definition at line 312 of file dbi.h.

Constructor & Destructor Documentation

wx::DBI::StatementCache::StatementCache (  Database *  pdbNew  ) 
 

virtual wx::DBI::StatementCache::~StatementCache (   )  [virtual]
 

wx::DBI::StatementCache::StatementCache (   )  [private]
 

Member Function Documentation

virtual void wx::DBI::StatementCache::CacheExecute (  const wxString &  sName,
const wxString &  sQuery,
const ArrayRecord &  arParameters,
HashRecordArray &  hraResult
)  [virtual]
 

Prepare, cache and execute a query returning an HashRecordArray.

Return a all result records as an HashRecordArray.

Parameters:
sName The name to use for the prepared query in the Cache.
sQuery The SQL query.
arParameters Parameters for the query.
out] hraResult All returned records.

virtual void wx::DBI::StatementCache::CacheExecute (  const wxString &  sName,
const wxString &  sQuery,
const ArrayRecord &  arParameters,
ArrayRecordArray &  araResult
)  [virtual]
 

Prepare, cache and execute a query returning an ArrayRecordArray.

Return a all result records as an ArrayRecordArray.

Parameters:
sName The name to use for the prepared query in the Cache.
sQuery The SQL query.
arParameters Parameters for the query.
out] araResult All returned records.

virtual void wx::DBI::StatementCache::CacheExecute (  const wxString &  sName,
const wxString &  sQuery,
const ArrayRecord &  arParameters,
HashRecord &  hrResult
)  [virtual]
 

Prepare, cache and execute a query returning an HashRecord.

Return a single result record as an HashRecord.

Parameters:
sName The name to use for the prepared query in the Cache.
sQuery The SQL query.
arParameters Parameters for the query.
out] hrResult The first returned record.

virtual void wx::DBI::StatementCache::CacheExecute (  const wxString &  sName,
const wxString &  sQuery,
const ArrayRecord &  arParameters,
ArrayRecord &  arResult
)  [virtual]
 

Prepare, cache and execute a query returning an ArrayRecord.

Return a single result record as an ArrayRecord.

Parameters:
sName The name to use for the prepared query in the Cache.
sQuery The SQL query.
arParameters Parameters for the query.
out] arResult The first returned record.

virtual void wx::DBI::StatementCache::CacheExecute (  const wxString &  sName,
const wxString &  sQuery,
const ArrayRecord &  arParameters,
wxVariant &  v
)  [virtual]
 

Prepare, cache and execute a query returning the first field of the first result.

Return a the value of the first field of the first record as a wxVariant.

Parameters:
sName The name to use for the prepared query in the Cache.
sQuery The SQL query.
arParameters Parameters for the query.
out] v The first field of the returned record.

virtual void wx::DBI::StatementCache::CacheExecute (  const wxString &  sName,
const wxString &  sQuery,
const ArrayRecord &  arParameters = ArrayRecord()
)  [virtual]
 

Prepare, cache and execute a query without returning a result.

Executes the queries and ignores any results.

Parameters:
sName The name to use for the prepared query in the Cache.
sQuery The SQL query.
arParameters Parameters for the query.

virtual void wx::DBI::StatementCache::CacheExecuteInsert (  const wxString &  sName,
const wxString &  sQuery,
const ArrayRecord &  arParameters,
long &  nLastInsertId
)  [virtual]
 

Prepare, cache and execute a query returning the new id.

This function calls the database-engine specific function which retrieves the last insert id, if such a function is available.

Parameters:
sName The name to use for the prepared query in the Cache.
sQuery The SQL query.
arParameters Parameters for the query.
out] nLastInsertId The last id.
Exceptions:
Throws an exception if the databse engine does not have a method for obtaining the last id inserted.

virtual void wx::DBI::StatementCache::Clear (   )  [virtual]
 

void wx::DBI::StatementCache::Delete (  const wxString &  sName  )  [private]
 

Delete a query from the cache.

Parameters:
sName The name used for the prepared query in the Cache.

virtual void wx::DBI::StatementCache::ExecuteTemporary (  const wxString &  sQuery,
const ArrayRecord &  arParameters,
ArrayRecordArray &  araResult
)  [virtual]
 

Execute a query.

The query is not cached. The results are returned in an ArrayRecordArray

Parameters:
sQuery The SQL query.
arParameters Parameters for the query.
out] araResult All returned records.

virtual void wx::DBI::StatementCache::ExecuteTemporary (  const wxString &  sQuery,
const ArrayRecord &  arParameters = ArrayRecord()
)  [virtual]
 

Execute a query.

The query is not cached, and the results are ignored.

Parameters:
sQuery The SQL query.
arParameters Parameters for the query.

bool wx::DBI::StatementCache::Exists (  const wxString &  sName  )  [private]
 

Cehck if a query exists in the cache.

Parameters:
sName The name used for the prepared query in the Cache.

Statement* wx::DBI::StatementCache::HandleCaching (  const wxString &  sName,
const wxString &  sQuery
)  [private]
 

Member Data Documentation

Cache wx::DBI::StatementCache::cch [protected]
 

Definition at line 485 of file dbi.h.

Database* wx::DBI::StatementCache::pdb [protected]
 

Definition at line 486 of file dbi.h.

The documentation for this class was generated from the following file:
Generated on Wed Jan 25 08:13:21 2006 for Sherpa wxWidgets Classes by doxygen 1.3.6