$darkmode
Defines the record iterator class for Table-based iterators. More...
Public Member Functions | |
| constructor (AbstractTable table, *hash< auto > where_cond, *hash< auto > search_options) | |
| creates the iterator More... | |
| *hash< string, AbstractDataField > | getRecordType () |
| Returns the record description, if available. More... | |
| auto | memberGate (string key) |
| Returns the value of the given field in the current record, if the iterator is valid. More... | |
Public Member Functions 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... | |
Protected Attributes | |
| AbstractTable | table |
| The table being iterated. | |
Protected Attributes inherited from DbDataProvider::AbstractDbRecordIterator | |
| bool | release_transaction |
| release the transaction with a rollback in the destructor? | |
| AbstractSQLStatement | stmt |
| the statement being iterated | |
Defines the record iterator class for Table-based iterators.
| DbDataProvider::DbTableRecordIterator::constructor | ( | AbstractTable | table, |
| *hash< auto > | where_cond, | ||
| *hash< auto > | search_options | ||
| ) |
creates the iterator
| table | the table to iteratate |
| search_options | search options; assumed to have already been processed for validity before this call |
Returns the record description, if available.
| auto DbDataProvider::DbTableRecordIterator::memberGate | ( | string | key | ) |
Returns the value of the given field in the current record, if the iterator is valid.
| key | the name of the field |
| FIELD-ERROR | invalid or unknown field name |