Package groovy.sql

Class BatchingStatementWrapper

java.lang.Object
groovy.lang.GroovyObjectSupport
groovy.sql.BatchingStatementWrapper
All Implemented Interfaces:
GroovyObject, AutoCloseable
Direct Known Subclasses:
BatchingPreparedStatementWrapper
public class BatchingStatementWrapper extends GroovyObjectSupport implements AutoCloseable
Class which delegates to a Statement but keeps track of a batch count size. If the batch count reaches the predefined number, this Statement does an executeBatch() automatically. If batchSize is zero, then no batching is performed.

  • Field Details

    • batchSize

      protected int batchSize
      Automatic execution threshold; 0 disables automatic partitioning.

    • batchCount

      protected int batchCount
      Number of commands added since the last delegate batch execution.

    • log

      protected Logger log
      Logger used for batch diagnostics.

    • results

      protected List<Integer> results
      Accumulated update counts across delegate batch executions.

  • Constructor Details

    • BatchingStatementWrapper

      public BatchingStatementWrapper(Statement delegate, int batchSize, Logger log)
      Creates a batching wrapper for a statement.
      Parameters:
      delegate - the statement to wrap
      batchSize - the automatic execution threshold; 0 disables automatic partitioning
      log - the logger to use for batch diagnostics

  • Method Details

    • reset

      protected void reset()
      Resets the wrapper's in-memory batch bookkeeping.

    • invokeMethod

      public Object invokeMethod(String name, Object args)
      Delegates unknown method calls to the wrapped Statement.
      Specified by:
      invokeMethod in interface GroovyObject
      Parameters:
      name - the method name
      args - the method arguments
      Returns:
      the delegated result

    • addBatch

      public void addBatch(String sql) throws SQLException
      Adds a SQL command to the current batch.
      Parameters:
      sql - the SQL command to add
      Throws:
      SQLException - if the command cannot be added

    • incrementBatchCount

      protected void incrementBatchCount() throws SQLException
      Increments batch count (after addBatch(..) has been called) and execute delegate.executeBatch() if batchSize has been reached.
      Throws:
      SQLException

    • clearBatch

      public void clearBatch() throws SQLException
      Clears the current batch and resets this wrapper's batch bookkeeping.
      Throws:
      SQLException - if the wrapped statement fails to clear its batch

    • executeBatch

      public int[] executeBatch() throws SQLException
      Executes any pending batched commands and returns the aggregated update counts.
      Returns:
      one update count per executed batch command
      Throws:
      SQLException - if batch execution fails

    • processResult

      protected void processResult(int[] lastResult)
      Incorporates one delegate batch execution result into this wrapper's state.
      Parameters:
      lastResult - the update counts returned by the wrapped statement

    • close

      public void close() throws SQLException
      Closes the wrapped statement.
      Specified by:
      close in interface AutoCloseable
      Throws:
      SQLException - if the statement cannot be closed