java.lang.Object
org.firebirdsql.gds.ng.FbBatchConfig.Immutable
- All Implemented Interfaces:
FbBatchConfig
- Enclosing interface:
- FbBatchConfig
Class to provide an immutable copy of a batch config.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.firebirdsql.gds.ng.FbBatchConfig
FbBatchConfig.Immutable -
Field Summary
Fields inherited from interface org.firebirdsql.gds.ng.FbBatchConfig
CONTINUE_ON_ERROR, HALT_AT_FIRST_ERROR, NO_UPDATE_COUNTS, SERVER_DEFAULT_BUFFER_SIZE, SERVER_DEFAULT_DETAILED_ERRORS, SERVER_MAXIMUM_BUFFER_SIZE, UPDATE_COUNTS -
Method Summary
Modifier and TypeMethodDescriptionintServer-side batch buffer size in bytes.intNumber of detailed errors to return.booleanMulti-error behaviour.booleanReport update counts per element (called "record counts" in Firebird).Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.firebirdsql.gds.ng.FbBatchConfig
populateBatchParameterBuffer
-
Method Details
-
multiError
public boolean multiError()Description copied from interface:FbBatchConfigMulti-error behaviour.- Specified by:
multiErrorin interfaceFbBatchConfig- Returns:
truerequest multi-error (continue on failure), orfalseto halt execution on first error
-
updateCounts
public boolean updateCounts()Description copied from interface:FbBatchConfigReport update counts per element (called "record counts" in Firebird).- Specified by:
updateCountsin interfaceFbBatchConfig- Returns:
truereport update counts,falsedo not report update counts
-
detailedErrors
public int detailedErrors()Description copied from interface:FbBatchConfigNumber of detailed errors to return.A value of
0disables detailed errors. When a value< 0is returned, the server-side default is used (64 as of Firebird 4). Requesting detailed errors exceeding the maximum (256 as of Firebird 4) will be silently set to the server maximum.- Specified by:
detailedErrorsin interfaceFbBatchConfig- Returns:
- number of detailed errors,
0to disable detailed errors,< 0for server default
-
batchBufferSize
public int batchBufferSize()Description copied from interface:FbBatchConfigServer-side batch buffer size in bytes.When a value
< 0is returned, the server-side default (16MB as of Firebird 4) will be used. When a value of0is returned , the server-side maximum will be used. Requesting buffer sizes exceeding the maximum (256MB as of Firebird 4) will be silently set to the server maximum.- Specified by:
batchBufferSizein interfaceFbBatchConfig- Returns:
- maximum batch buffer size, return
< 0to use server-side default (16MB as of Firebird 4),0for the server-side maximum (256MB as of Firebird 4)
-
immutable
- Specified by:
immutablein interfaceFbBatchConfig- Returns:
- immutable, frozen copy of this batch config
-