$darkmode
Defines the record iterator class for Table-based iterators. More...
Inherits AbstractDataProviderBulkRecordInterface.
Public Member Functions | |
| constructor (int block_size, AbstractTable table, *hash< auto > where_cond, *hash< auto > search_options) | |
| 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... | |
| keepTransactionLock () | |
| Ensures that no rollback is performed when the object is destroyed. | |
Protected Member Functions | |
| hash< string, list< auto > > | getValueImpl () |
| Returns a hash of lists according to the block size. More... | |
Private Attributes | |
| bool | release_transaction |
| release the transaction with a rollback in the destructor? | |
| AbstractSQLStatement | stmt |
| the statement being iterated | |
| AbstractTable | table |
| The table being iterated. | |
Defines the record iterator class for Table-based iterators.
| DbDataProvider::DbTableBulkRecordInterface::constructor | ( | int | block_size, |
| AbstractTable | table, | ||
| *hash< auto > | where_cond, | ||
| *hash< auto > | search_options | ||
| ) |
creates the iterator
| block_size | the number of records in a read block; must be a positive number |
| table | the table to iteratate |
| where_cond | the search criteria; will be processed by processFieldValues() |
| search_options | search options; assumed to have already been processed for validity before this call |
Returns the record description, if available.
Returns a hash of lists according to the block size.
| INVALID-ITERATOR | the iterator is not pointing at a valid element |