Qore TableMapper Module Reference 1.0

- Main Page
- Related Pages
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Functions Variables Groups Pages
Public Member Functions | Private Attributes | List of all members
TableMapper::InboundTableMapperIterator Class Reference

provides a hash iterator based on a InboundTableMapper object and an iterator input source; for each iteration the iterted row is inserted into the Table target More...

Inheritance diagram for TableMapper::InboundTableMapperIterator:
[legend]

## Public Member Functions
nothing | commit ()
| commits the transaction
int | commitLimit ()
| returns the commit_limit value set in the constructor()
| constructor (Qore::AbstractIterator i, SqlUtil::Table table, hash map, *hash opts, int commit_limit=0)
| creates the iterator from the arguments passed More...
| constructor (Qore::AbstractIterator i, SqlUtil::AbstractTable table, hash map, *hash opts, int commit_limit=0)
| creates the iterator from the arguments passed More...
| constructor (Qore::AbstractIterator i, TableMapper::InboundTableMapper map, int commit_limit=0)
| creates the iterator from the arguments passed More...
int | getCount ()
| returns the internal record count More...
string | getTableName ()
| returns the table name
hash | getValue ()
| returns the current row transformed with the mapper
bool | next ()
| Moves the current position of the input iterator to the next element; returns False if there are no more elements otherwise inserts the row in the target table and returns True. More...
| resetCount ()
| resets the internal record count More...
nothing | rollback ()
| rolls back the transaction

## Private Attributes
int | cnt = 0
| row count for commit
int | commit_limit
| row commit limit (<= 0 for no commits)
TableMapper::InboundTableMapper | map
| data mapper
hash | val
| a copy of the last hash value mapped

## Detailed Description

provides a hash iterator based on a InboundTableMapper object and an iterator input source; for each iteration the iterted row is inserted into the Table target

## Member Function Documentation

TableMapper::InboundTableMapperIterator::constructor | ( | Qore::AbstractIterator | i,
|  | SqlUtil::Table | table,
|  | hash | map,
|  | *hash | opts,
|  | int | commit_limit = `0`
| ) |  |

creates the iterator from the arguments passed

The target table is also scanned using SqlUtil and column definitions are used to update the target record specification, also if there are any columns with NOT NULL constraints and no default value, mapping, or constant value, then a MAP-ERROR exception is thrown

Example:
  const DbMapper = (
  "id": ("sequence": "seq_inventory_example"),
  "store_code": "StoreCode",
  "product_code": "ProductCode",
  "product_desc": "ProductDescription",
  "ordered": "Ordered",
  "available": "Available",
  "in_transit": "InTransit",
  "total": int sub (any $x, hash $rec) { return $rec.Available.toInt() + $rec.Ordered.toInt() + $rec.InTransit.toInt(); },
  );
  my InboundTableMapperIterator $i($input, $table, DbMapper);

Parameters

  i | input iterator; AbstractIterator::getValue() must return a hash
  table | the target table object
  map | 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 documnentation for this option
  opts | an optional hash of options for the mapper; see Mapper Options for a description of valid mapper options
  commit_limit | row count before a commit is made; if <= 0 then no commits are made by this object, otherwise a commit is made for each commit_limit rows processed by this object, commits are made in calls to next()

Note
  by default commit_limit is 0 meaning that this object will make no commits; in this case the transaction will have to be commited explicitly externally

TableMapper::InboundTableMapperIterator::constructor | ( | Qore::AbstractIterator | i,
|  | SqlUtil::AbstractTable | table,
|  | hash | map,
|  | *hash | opts,
|  | int | commit_limit = `0`
| ) |  |

creates the iterator from the arguments passed

The target table is also scanned using SqlUtil and column definitions are used to update the target record specification, also if there are any columns with NOT NULL constraints and no default value, mapping, or constant value, then a MAP-ERROR exception is thrown

Example:
  const DbMapper = (
  "id": ("sequence": "seq_inventory_example"),
  "store_code": "StoreCode",
  "product_code": "ProductCode",
  "product_desc": "ProductDescription",
  "ordered": "Ordered",
  "available": "Available",
  "in_transit": "InTransit",
  "total": int sub (any $x, hash $rec) { return $rec.Available.toInt() + $rec.Ordered.toInt() + $rec.InTransit.toInt(); },
  );
  my InboundTableMapperIterator $i($input, $table, DbMapper);

Parameters

  i | input iterator; AbstractIterator::getValue() must return a hash
  table | the target table object
  map | 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 documnentation for this option
  opts | an optional hash of options for the mapper; see Mapper Options for a description of valid mapper options
  commit_limit | row count before a commit is made; if <= 0 then no commits are made by this object, otherwise a commit is made for each commit_limit rows processed by this object, commits are made in calls to next()

Note
  by default commit_limit is 0 meaning that this object will make no commits; in this case the transaction will have to be commited explicitly externally

TableMapper::InboundTableMapperIterator::constructor | ( | Qore::AbstractIterator | i,
|  | TableMapper::InboundTableMapper | map,
|  | int | commit_limit = `0`
| ) |  |

creates the iterator from the arguments passed

The target table is also scanned using SqlUtil and column definitions are used to update the target record specification, also if there are any columns with NOT NULL constraints and no default value, mapping, or constant value, then a MAP-ERROR exception is thrown

Example:
  const DbMapper = (
  "id": ("sequence": "seq_inventory_example"),
  "store_code": "StoreCode",
  "product_code": "ProductCode",
  "product_desc": "ProductDescription",
  "ordered": "Ordered",
  "available": "Available",
  "in_transit": "InTransit",
  "total": int sub (any $x, hash $rec) { return $rec.Available.toInt() + $rec.Ordered.toInt() + $rec.InTransit.toInt(); },
  );
  my InboundTableMapper $map($table, DbMapper);
  my InboundTableMapperIterator $i($input, $map);

Parameters

  i | input iterator; AbstractIterator::getValue() must return a hash
  map | the mapper to transform the data
  commit_limit | row count before a commit is made; if <= 0 then no commits are made by this object, otherwise a commit is made for each commit_limit rows processed by this object, commits are made in calls to next()

int TableMapper::InboundTableMapperIterator::getCount | ( |  | ) |

returns the internal record count

See Also
  resetCount()

bool TableMapper::InboundTableMapperIterator::next | ( |  | ) |

Moves the current position of the input iterator to the next element; returns False if there are no more elements otherwise inserts the row in the target table and returns True.

if commit_limit is > 0 then TableMapper::InboundTableMapper::commit() is called for every commit_limit rows according to the internal row count

Returns
  False if there are no more elements, in this case if there is an uncommitted transaction according to the internal row count, then TableMapper::InboundTableMapper::commit() is called as well

TableMapper::InboundTableMapperIterator::resetCount | ( |  | ) |

resets the internal record count

See Also
  getCount()