public interface FbBatchConfig
Modifier and Type | Interface and Description |
---|---|
static class |
FbBatchConfig.Immutable
Class to provide an immutable copy of a batch config.
|
Modifier and Type | Field and Description |
---|---|
static boolean |
CONTINUE_ON_ERROR
multiError() value to signal to continue execution on errors. |
static boolean |
HALT_AT_FIRST_ERROR
multiError() value to signal to halt execution at first error. |
static boolean |
NO_UPDATE_COUNTS
updateCounts() value to signal to no supply update counts. |
static int |
SERVER_DEFAULT_BUFFER_SIZE
batchBufferSize() value to signal to use server default batch buffer size. |
static int |
SERVER_DEFAULT_DETAILED_ERRORS
detailedErrors() value to signal to use server default detailed errors. |
static int |
SERVER_MAXIMUM_BUFFER_SIZE
batchBufferSize() value to signal to use server maximum batch buffer size. |
static boolean |
UPDATE_COUNTS
updateCounts() value to signal to supply update counts. |
Modifier and Type | Method and Description |
---|---|
int |
batchBufferSize()
Server-side batch buffer size in bytes.
|
int |
detailedErrors()
Number of detailed errors to return.
|
default FbBatchConfig |
immutable() |
boolean |
multiError()
Multi-error behaviour.
|
static FbBatchConfig |
of(boolean multiError,
boolean updateCounts,
int detailedErrors,
int batchBufferSize)
Creates an immutable batch config.
|
default void |
populateBatchParameterBuffer(BatchParameterBuffer batchPb)
Populates the provided batch parameter buffer with the configuration.
|
boolean |
updateCounts()
Report update counts per element (called "record counts" in Firebird).
|
static final boolean CONTINUE_ON_ERROR
multiError()
value to signal to continue execution on errors.static final boolean HALT_AT_FIRST_ERROR
multiError()
value to signal to halt execution at first error.static final boolean UPDATE_COUNTS
updateCounts()
value to signal to supply update counts.static final boolean NO_UPDATE_COUNTS
updateCounts()
value to signal to no supply update counts.static final int SERVER_DEFAULT_DETAILED_ERRORS
detailedErrors()
value to signal to use server default detailed errors.
NOTE: all negative values signal this. If you want to use this to check against a value,
use <= SERVER_DEFAULT_DETAILED_ERRORS
.
static final int SERVER_MAXIMUM_BUFFER_SIZE
batchBufferSize()
value to signal to use server maximum batch buffer size.static final int SERVER_DEFAULT_BUFFER_SIZE
batchBufferSize()
value to signal to use server default batch buffer size.
NOTE: all negative values signal this. If you want to use this constant to check against a value,
use <= SERVER_DEFAULT_BUFFER_SIZE
.
boolean multiError()
true
request multi-error (continue on failure), or false
to halt execution on first errorboolean updateCounts()
true
report update counts, false
do not report update countsint detailedErrors()
A value of 0
disables detailed errors. When a value < 0
is 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.
0
to disable detailed errors, < 0
for server defaultint batchBufferSize()
When a value < 0
is returned, the server-side default (16MB as of Firebird 4) will be used.
When a value of 0
is 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.
< 0
to use server-side default (16MB as of Firebird 4),
0
for the server-side maximum (256MB as of Firebird 4)default FbBatchConfig immutable()
static FbBatchConfig of(boolean multiError, boolean updateCounts, int detailedErrors, int batchBufferSize)
default void populateBatchParameterBuffer(BatchParameterBuffer batchPb)
This method will remove previously set items which are managed by this method. Items not managed by this method
are untouched. At minimum this method manages items TAG_MULTIERROR
, TAG_RECORD_COUNTS
,
TAG_DETAILED_ERRORS
, and TAG_BUFFER_BYTES_SIZE
.
batchPb
- batch parameter buffer to populate.Copyright © 2001-2024 Jaybird (Firebird JDBC) team. All rights reserved.