Qore jni Module  1.2.0
org.qore.lang.bulksqlutil.BulkUpsertOperation Class Reference

base class for bulk DML upsert operations More...

Inheritance diagram for org.qore.lang.bulksqlutil.BulkUpsertOperation:
org.qore.lang.bulksqlutil.AbstractBulkOperation org.qore.jni.QoreObjectWrapper

Public Member Methods

 BulkUpsertOperation (AbstractTable target, Map< String, Object > opts) throws Throwable
 creates the object from the supplied arguments More...
 
 BulkUpsertOperation (AbstractTable target) throws Throwable
 creates the object from the supplied arguments More...
 
- Public Member Methods inherited from org.qore.lang.bulksqlutil.AbstractBulkOperation
 AbstractBulkOperation (QoreObject obj) throws Throwable
 creates a new AbstractBulkOperation object wrapping the Qore object
 
void queueData (Map< String, Object > data) throws Throwable
 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 More...
 
void queueData (Map< String, Object >[] l) throws Throwable
 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 More...
 
void flush () throws Throwable
 flushes any remaining batched data to the database; this method should always be called before committing the transaction or destroying the object More...
 
void discard () throws Throwable
 discards any buffered batched data; this method should be called before destroying the object if an error occurs More...
 
void commit () throws Throwable
 flushes any queued data and commits the transaction
 
void rollback () throws Throwable
 discards any queued data and rolls back the transaction
 
String getTableName () throws Throwable
 returns the table name
 
AbstractTable getTable () throws Throwable
 returns the underlying SqlUtil::AbstractTable object
 
AbstractDatasource getDatasource () throws Throwable
 returns the AbstractDatasource object associated with this object
 
int getRowCount () throws Throwable
 returns the affected row count
 
- Public Member Methods inherited from org.qore.jni.QoreObjectWrapper
 QoreObjectWrapper (QoreObject obj)
 creates the wrapper object with the Qore object
 
void release ()
 releases the Qore object; do not call any further methods on the object after this call
 
QoreObject getQoreObject ()
 returns the Qore object
 
String className ()
 returns the class name for the Qore object
 
boolean instanceOf (String class_name)
 returns true if the object is an instance of the given class
 

Additional Inherited Members

- Private Attributes inherited from org.qore.jni.QoreObjectWrapper
QoreObject obj
 the wrapper Qore object
 

Detailed Description

base class for bulk DML upsert operations

This class assists with bulk upsert (SQL merge) operations 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.
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.
// single commit and rollback
try {
// data is queued and flushed automatically when the buffer is full
for (Map<String, Object> i : data1) {
op1.queueData(i);
}
for (Map<String, Object> i : data2) {
op2.queueData(i);
}
// each operation needs to be flushed or discarded individually
op1.flush();
op2.flush();
ds.commit();
} catch (Throwable e) {
op1.discard();
op2.discard();
ds.rollback();
throw e;
}
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 Qore destructor. See the example above for more information.

Constructor & Destructor Documentation

◆ BulkUpsertOperation() [1/2]

org.qore.lang.bulksqlutil.BulkUpsertOperation.BulkUpsertOperation ( AbstractTable  target,
Map< String, Object >  opts 
) throws Throwable
inline

creates the object from the supplied arguments

Parameters
targetthe target table object
optsan optional hash of options for the object as follows:
  • "block_size": the number of rows executed at once (default: 1000)
  • "info_log": an optional info logging callback of type LogCallback
  • "upsert_strategy": the upsert strategy to use; default AbstractTable.UpsertAuto; see Upsert Strategy Codes for possible values for the upsert strategy

◆ BulkUpsertOperation() [2/2]

org.qore.lang.bulksqlutil.BulkUpsertOperation.BulkUpsertOperation ( AbstractTable  target) throws Throwable
inline

creates the object from the supplied arguments

Parameters
targetthe target table object

The documentation for this class was generated from the following file:
org.qore.lang.bulksqlutil.BulkUpsertOperation.BulkUpsertOperation
BulkUpsertOperation(AbstractTable target, Map< String, Object > opts)
creates the object from the supplied arguments
Definition: BulkUpsertOperation.java:74