spring-framework / org.springframework.jdbc.object / BatchSqlUpdate

BatchSqlUpdate

open class BatchSqlUpdate : SqlUpdate

SqlUpdate subclass that performs batch update operations. Encapsulates queuing up records to be updated, and adds them as a single batch once flush is called or the given batch size has been met.

Note that this class is a non-thread-safe object, in contrast to all other JDBC operations objects in this package. You need to create a new instance of it for each use, or call reset before reuse within the same thread.

Author
Keith Donald

Author
Juergen Hoeller

Since
1.1

See Also
#flush #reset

Constructors

<init>

BatchSqlUpdate()

Constructor to allow use as a JavaBean. DataSource and SQL must be supplied before compilation and use.

BatchSqlUpdate(ds: DataSource, sql: String)

Construct an update object with a given DataSource and SQL.

BatchSqlUpdate(ds: DataSource, sql: String, types: IntArray)

Construct an update object with a given DataSource, SQL and anonymous parameters.

BatchSqlUpdate(ds: DataSource, sql: String, types: IntArray, batchSize: Int)

Construct an update object with a given DataSource, SQL, anonymous parameters and specifying the maximum number of rows that may be affected.

Properties

DEFAULT_BATCH_SIZE

static var DEFAULT_BATCH_SIZE: Int

Default number of inserts to accumulate before commiting a batch (5000).

Functions

flush	`open fun flush(): IntArray` Trigger any queued update operations to be added as a final batch.
getExecutionCount	`open fun getExecutionCount(): Int` Return the number of already executed statements.
getQueueCount	`open fun getQueueCount(): Int` Return the current number of statements or statement parameters in the queue.
getRowsAffected	`open fun getRowsAffected(): IntArray` Return the number of affected rows for all already executed statements. Accumulates all of `flush`'s return values until `reset` is invoked.
reset	`open fun reset(): Unit` Reset the statement parameter queue, the rows affected cache, and the execution count.
setBatchSize	`open fun setBatchSize(batchSize: Int): Unit` Set the number of statements that will trigger an automatic intermediate flush. `update` calls or the given statement parameters will be queued until the batch size is met, at which point it will empty the queue and execute the batch. You can also flush already queued statements with an explicit `flush` call. Note that you need to this after queueing all parameters to guarantee that all statements have been flushed.
setTrackRowsAffected	`open fun setTrackRowsAffected(trackRowsAffected: Boolean): Unit` Set whether to track the rows affected by batch updates performed by this operation object. Default is "true". Turn this off to save the memory needed for the list of row counts.
update	`open fun update(vararg params: Any): Int` Overridden version of `update` that adds the given statement parameters to the queue rather than executing them immediately. All other `update` methods of the SqlUpdate base class go through this method and will thus behave similarly. You need to call `flush` to actually execute the batch. If the specified batch size is reached, an implicit flush will happen; you still need to finally call `flush` to flush all statements.