public interface IDfBatchManager
Batch size (the number of objects) is a hint to the server to allocate memory for caching the data. When the cache reaches its limit, the server will flush the data into database.
By default, queries issued against a batch object type during the batch will cause the server to flush the cached
object. By setting the flushBatchQuery flag to false, the client can tell the server not to flush the
data if the query is not affected by the data created inside the batch. The flushBatchQuery flag is
used as default by queries inside the transaction but any query can override this flag by using the
method IDfQuery.setFlushBatchQuery
.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
BATCH_SIZE |
static int |
MAX_BATCH_SIZE |
static java.lang.String |
ONE_AUDIT |
static java.lang.String |
ONE_EVENT |
Modifier and Type | Method and Description |
---|---|
void |
abortBatch()
Abort the batch operation and roll back the batch transaction.
|
void |
closeBatch()
Flush the batch, commit the transaction, and close the batch.
|
void |
commitBatch()
Flush the batch data into the repository and commit the transaction for the batch.
|
void |
flushBatch()
Flush the batch data into the repository.
|
java.util.List<IDfBatchGroup> |
getFailedGroups()
Get the failed groups in the transaction.
|
java.util.List<IDfBatchGroup> |
getGroups()
Get all groups in the current transaction
|
int |
getMaxBatchSize()
Get the setting for the batch size.
|
boolean |
isBatchActive()
Check to see if there is an active batch.
|
boolean |
isFlushBatchOnQuery()
Get the Boolean value for flushBatchOnQuery.
|
boolean |
isOneAuditPerBatch()
Get the Boolean setting for oneAuditPerBatch.
|
boolean |
isOneEventPerBatch()
Get the Boolean setting for oneEventPerBatch.
|
void |
newGroup()
Start a new group in the current batch.
|
void |
openBatch()
This openBatch() method opens an insert batch, using default values.
|
void |
openBatch(int size,
boolean flushBatchOnQuery,
boolean oneAuditPerBatch,
boolean oneEventPerBatch,
java.util.Properties options)
Opens an insert batch.
|
void |
openBatchGroup(int size,
boolean flushBatchOnQuery,
boolean oneAuditPerBatch,
boolean oneEventPerBatch,
java.lang.String ignoreInsertError)
Opens an insert batch that uses groups.
|
static final int MAX_BATCH_SIZE
static final java.lang.String BATCH_SIZE
static final java.lang.String ONE_AUDIT
static final java.lang.String ONE_EVENT
void openBatch() throws DfException
DfException
- if operation failsvoid openBatch(int size, boolean flushBatchOnQuery, boolean oneAuditPerBatch, boolean oneEventPerBatch, java.util.Properties options) throws DfException
size
- Size of the batchflushBatchOnQuery
- A flag passed to the server by queries inside the batch if not overridden
by the queryoneAuditPerBatch
- Generate one audit trail per batch size; the server only honors this flag
if the caller has Audit Config privilege.oneEventPerBatch
- Combines object creation events into a dm_batch_flush event to reduce the
number of events generated during object creation.options
- Database-specific optionsDfException
- Thrown if the operation fails
//@see #com.documentum.fc.client.IDfQuery.setFlushBatchQueryvoid openBatchGroup(int size, boolean flushBatchOnQuery, boolean oneAuditPerBatch, boolean oneEventPerBatch, java.lang.String ignoreInsertError) throws DfException
size
- Size of the batchflushBatchOnQuery
- A flag passed to the server by queries inside the batch if not overridden
by the queryoneAuditPerBatch
- Generate one audit trail per batch size; the server only honors this flag
if the caller has Audit Config privilege.oneEventPerBatch
- Combines object creation events into a dm_batch_flush event to reduce the
number of events generated during object creation.ignoreInsertError
- is a comma separated list of registered tables. Insert errors from these tables will be ignored,
but errors from tables not in the list will roll back the batch transaction.DfException
- Thrown if the operation fails
//@see #com.documentum.fc.client.IDfQuery.setFlushBatchQueryvoid flushBatch() throws DfException
DfException
- if operation failsvoid commitBatch() throws DfException
DfException
- if operation failsvoid abortBatch() throws DfException
DfException
- if operation failsvoid closeBatch() throws DfException
DfException
- if operation fails.boolean isOneAuditPerBatch()
boolean isOneEventPerBatch()
boolean isBatchActive()
boolean isFlushBatchOnQuery()
void newGroup() throws DfException
DfException
java.util.List<IDfBatchGroup> getGroups()
java.util.List<IDfBatchGroup> getFailedGroups()
int getMaxBatchSize()
Copyright 1994-2023 OpenText Corporation. All rights reserved.