provides a hash iterator based on a mapper object and an SQLStatement or SqlUtil select hash
More...
provides a hash iterator based on a mapper object and an SQLStatement or SqlUtil select hash
provides support for bulk DML:
| int TableMapper::SqlStatementMapperIterator::getCount |
( |
| ) |
|
| list TableMapper::SqlStatementMapperIterator::mapBulk |
( |
int |
size | ) |
|
performs bulk mapping by selecting the requested number of rows in a single select
- Parameters
-
| size | the number of rows to return |
- Returns
- a list of mapped hashes with a maximum number of rows corresponding to the size argument; in case there is less input data than requested, the list returned could have fewer rows than requested; in case there is no more data, the return value is an empty list
| TableMapper::SqlStatementMapperIterator::resetCount |
( |
| ) |
|
resets the internal record count
- See Also
- getCount()
| private TableMapper::SqlStatementMapperIterator::setup |
( |
hash |
mapv, |
|
|
*hash |
opts |
|
) |
| |
creates the iterator from the arguments passed
- Parameters
-
| table | SqlUtil::AbstractTable as a base for select hash sh |
| sh | a SqlUtil select hash (columns/joins/wheres...) |
| mapv | a hash providing field mappings; each hash key is the name of the output field; each value is either True (meaning no translations are done; the data is copied 1:1) or a hash describing the mapping; see Mapper Specification Format for detailed documentation for this option |
| opts | an optional hash of options for the mapper; see Mapper Options for a description of valid mapper options |
- Exceptions
-
| MAP-ERROR | the map hash has a logical error (ex: "trunc" key given without "maxlen", invalid map key)creates the iterator from the arguments passed |
- Parameters
-
| table | SqlUtil::Table as a base for select hash sh |
| sh | a SqlUtil select hash (columns/joins/wheres...) |
| mapv | a hash providing field mappings; each hash key is the name of the output field; each value is either True (meaning no translations are done; the data is copied 1:1) or a hash describing the mapping; see Mapper Specification Format for detailed documentation for this option |
| opts | an optional hash of options for the mapper; see Mapper Options for a description of valid mapper options |
- Exceptions
-
| MAP-ERROR | the map hash has a logical error (ex: "trunc" key given without "maxlen", invalid map key)creates the iterator from the arguments passed |
- Parameters
-
| stmt | already constructed SQLStatement object |
| mapv | the mapper to transform the data |
| opts | an optional hash of options for the mapper; see Mapper Options for a description of valid mapper options |