Qore DbDataProvider Module Reference  1.0
DbDataProvider::DbSelectRecordIterator Class Reference

Defines the record iterator class for Table-based iterators. More...

Inheritance diagram for DbDataProvider::DbSelectRecordIterator:

Public Member Methods

auto memberGate (string key)
 Returns the value of the given field in the current record, if the iterator is valid. More...
 
- Public Member Methods inherited from DbDataProvider::AbstractDbRecordIterator
 constructor (bool release_transaction, AbstractSQLStatement stmt)
 creates the iterator More...
 
 destructor ()
 rolls back the transaction if a transaction lock was acquired in the constructor and keepTransactionLock() was not called
 
*hash< string, AbstractDataField > getRecordType ()
 Returns the record description, if available. More...
 
hash< auto > getValue ()
 Returns a single record if the iterator is valid. More...
 
 keepTransactionLock ()
 Ensures that no rollback is performed when the object is destroyed.
 
bool next ()
 Increments the row pointer when retrieving rows from a select statement; returns True if there is a row to retrieve, False if not. More...
 
bool valid ()
 Returns True if the iterator is valid. More...
 

Static Private Member Methods

static AbstractSQLStatement prepareStatement (AbstractSQLStatement stmt, hash< auto > select_options)
 Prepares the AbstractSQLStatement object for the iterator.
 

Private Attributes

*hash< auto > where_cond
 search conditions
 
- Private Attributes inherited from DbDataProvider::AbstractDbRecordIterator
bool release_transaction
 release the transaction with a rollback in the destructor?
 
AbstractSQLStatement stmt
 the statement being iterated
 

Detailed Description

Defines the record iterator class for Table-based iterators.

Member Function Documentation

◆ memberGate()

auto DbDataProvider::DbSelectRecordIterator::memberGate ( string  key)

Returns the value of the given field in the current record, if the iterator is valid.

Parameters
keythe name of the field
Returns
the value of the given field in the current record, if the iterator is valid
Exceptions
FIELD-ERRORinvalid or unknown field name