|
| | constructor (SqlUtil::AbstractTable target, *hash opts) |
| | creates the object from the supplied arguments
|
| | constructor (SqlUtil::Table target, *hash opts) |
| | creates the object from the supplied arguments
|
| | setRowCode (*code rowc) |
| | sets a closure or call reference that will be called when data has been sent to the database and all output data is available; must accept a hash argument that represents the data written to the database including any output arguments. This code will be reset, once the transaction is commited.
|
|
nothing | commit () |
| | flushes any queued data and commits the transaction
|
| | constructor (string name, SqlUtil::AbstractTable target, *hash opts) |
| | creates the object from the supplied arguments
|
| | constructor (string name, SqlUtil::Table target, *hash opts) |
| | creates the object from the supplied arguments
|
| | destructor () |
| | throws an exception if there is data pending in the internal row data cache; make sure to call flush() or discard() before destroying the object
|
| | discard () |
| | discards any buffered batched data; this method should be called before destroying the object if an error occurs
|
| | flush () |
| | flushes any remaining batched data to the database; this method should always be called before committing the transaction or destroying the object
|
|
Qore::SQL::AbstractDatasource | getDatasource () |
| | returns the AbstractDatasource object associated with this object
|
|
int | getRowCount () |
| | returns the affected row count
|
|
SqlUtil::AbstractTable | getTable () |
| | returns the underlying SqlUtil::AbstractTable object
|
|
string | getTableName () |
| | returns the table name
|
| | queueData (hash data) |
| | queues row data in the block buffer; the block buffer is flushed to the DB if the buffer size reaches the limit defined by the block_size option; does not commit the transaction
|
| | queueData (list< auto > l) |
| | queues row data in the block buffer; the block buffer is flushed to the DB if the buffer size reaches the limit defined by the block_size option; does not commit the transaction
|
|
nothing | rollback () |
| | discards any queued data and rolls back the transaction
|
| int | size () |
| | returns the current size of the cache as a number of rows
|
|
| | flushImpl () |
| | inserts internally-queued queued data in the database with bulk DML operations
|
|
| init (*hash opts) |
| | common constructor initialization
|
|
| setupInitialRow (hash row) |
| | sets up support for "returning" insert options for any possible rowcode member
|
|
| setupInitialRowColumns (hash row) |
| | sets up the block buffer given the initial template hash of lists for inserting
|
|
abstract | flushImpl () |
| | flushes queued data to the database
|
|
| flushIntern () |
| | flushes queued data to the database
|
|
| init (*hash< auto > opts) |
| | common constructor initialization
|
|
| setupInitialRow (hash< auto > row) |
| | sets up the block buffer given the initial template row for inserting
|
|
| setupInitialRowColumns (hash< auto > row) |
| | sets up the block buffer given the initial template hash of lists for inserting
|
base class for bulk DML insert operations
This class assists with bulk inserts into a target table.
- Submitting Data
- To use this class, queue data in the form of a hash (a single row or a set of rows) or a list of rows by calling the queueData() method.
The queueData() method queues data to be written to the database; the queue is flush()ed automatically when block_size rows have been queued.
- Retrieving Data From Inserts
- It is possible to use sql_iop_funcs in the hashes submitted with queueData(); in this case the BulkInsertOperation class assumes that every row has the same operations as in the first row. Output data can then be processed by using the
rowcode option in the constructor() or by calling setRowCode().
In case sql_iop_funcs are used and a rowcode option is set, then the SQL DML query for inserts is creating using the "returning" insert option, therefore the DBI driver in this case must support this option as well.
- Flushing and Discarding Data
- Each call to flush() (whether implicit or explicit) will cause a single call to be made to the dataserver; all queued rows are sent in a single bulk DML call, which allows for efficient processing of large amounts of data.
A call to flush() must be made before committing the transaction to ensure that any remaining rows in the internal queue have been written to the database. Because the destructor() will throw an exception if any data is left in the internal queue when the object is destroyed, a call to discard() must be made prior to the destruction of the object in case of errors.
on_success ds.commit();
on_error ds.rollback();
{
BulkInsertOperation op1(table1);
BulkInsertOperation op2(table2);
on_success {
op1.flush();
op2.flush();
}
on_error {
op1.discard();
op2.discard();
}
map op1.queueData($1), data1.iterator();
map op2.queueData($1), data2.iterator();
}
- Note
- Each bulk DML object must be manually flush()ed before committing or manually discard()ed before rolling back to ensure that all data is managed properly in the same transaction and to ensure that no exception is thrown in the destructor(). See the example above for more information.
