$darkmode
Defines the record iterator class for Table-based iterators. More...
Inherits AbstractDataProviderBulkRecordInterface.
Public Member Functions | |
| constructor (int block_size, AbstractDatasource ds, *hash< auto > where_cond, hash< auto > select_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 | |
Defines the record iterator class for Table-based iterators.
| DbDataProvider::DbSelectBulkRecordInterface::constructor | ( | int | block_size, |
| AbstractDatasource | ds, | ||
| *hash< auto > | where_cond, | ||
| hash< auto > | select_options | ||
| ) |
creates the iterator
| block_size | the number of records in a read block; must be a positive number |
| ds | the datasource to use |
| where_cond | must be empty; an exception will be thrown if search conditions are passed to this constructor |
| select_options | search options; assumed to have already been processed for validity before this call; contains:
|
| DBSELECT-BULK-ERROR | where_cond must be empty |
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 |