Module java.sql
Package java.sql

Class BatchUpdateException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.sql.SQLException
java.sql.BatchUpdateException
All Implemented Interfaces:
Serializable,Iterable<Throwable>
public classBatchUpdateExceptionextendsSQLException
The subclass ofSQLException thrown when an error occurs during a batch update operation. In addition to the information provided bySQLException, aBatchUpdateException provides the update counts for all commands that were executed successfully during the batch update, that is, all commands that were executed before the error occurred. The order of elements in an array of update counts corresponds to the order in which commands were added to the batch.

After a command in a batch update fails to execute properly and aBatchUpdateException is thrown, the driver may or may not continue to process the remaining commands in the batch. If the driver continues processing after a failure, the array returned by the methodBatchUpdateException.getUpdateCounts will have an element for every command in the batch rather than only elements for the commands that executed successfully before the error. In the case where the driver continues processing commands, the array element for any command that failed isStatement.EXECUTE_FAILED.

A JDBC driver implementation should use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause) instead of constructors that takeint[] for the update counts to avoid the possibility of overflow.

IfStatement.executeLargeBatch method is invoked it is recommended thatgetLargeUpdateCounts be called instead ofgetUpdateCounts in order to avoid a possible overflow of the integer update count.

Since:
1.2
See Also:

  • Constructor Details

    • BatchUpdateException

      public BatchUpdateException(String reason,String SQLState, int vendorCode, int[] updateCounts)
      Constructs aBatchUpdateException object initialized with a givenreason,SQLState,vendorCode andupdateCounts. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method.

      Note: There is no validation ofupdateCounts for overflow and because of this it is recommended that you use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause).

      Parameters:
      reason - a description of the error
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      vendorCode - an exception code used by a particular database vendor
      updateCounts - an array ofint, with each element indicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure
      Since:
      1.2
      See Also:

    • BatchUpdateException

      public BatchUpdateException(String reason,String SQLState, int[] updateCounts)
      Constructs aBatchUpdateException object initialized with a givenreason,SQLState andupdateCounts. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method. The vendor code is initialized to 0.

      Note: There is no validation ofupdateCounts for overflow and because of this it is recommended that you use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause).

      Parameters:
      reason - a description of the exception
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      updateCounts - an array ofint, with each element indicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure
      Since:
      1.2
      See Also:

    • BatchUpdateException

      public BatchUpdateException(String reason, int[] updateCounts)
      Constructs aBatchUpdateException object initialized with a givenreason andupdateCounts. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method. TheSQLState is initialized tonull and the vendor code is initialized to 0.

      Note: There is no validation ofupdateCounts for overflow and because of this it is recommended that you use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause).

      Parameters:
      reason - a description of the exception
      updateCounts - an array ofint, with each element indicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure
      Since:
      1.2
      See Also:

    • BatchUpdateException

      public BatchUpdateException(int[] updateCounts)
      Constructs aBatchUpdateException object initialized with a givenupdateCounts. initialized by a call to theThrowable.initCause(java.lang.Throwable) method. Thereason andSQLState are initialized to null and the vendor code is initialized to 0.

      Note: There is no validation ofupdateCounts for overflow and because of this it is recommended that you use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause).

      Parameters:
      updateCounts - an array ofint, with each element indicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure
      Since:
      1.2
      See Also:

    • BatchUpdateException

      public BatchUpdateException()
      Constructs aBatchUpdateException object. Thereason,SQLState andupdateCounts are initialized tonull and the vendor code is initialized to 0. Thecause is not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable) method.
      Since:
      1.2
      See Also:

    • BatchUpdateException

      public BatchUpdateException(Throwable cause)
      Constructs aBatchUpdateException object initialized with a givencause. TheSQLState andupdateCounts are initialized tonull and the vendor code is initialized to 0. Thereason is initialized tonull ifcause==null or tocause.toString() ifcause!=null.
      Parameters:
      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6
      See Also:

    • BatchUpdateException

      public BatchUpdateException(int[] updateCounts,Throwable cause)
      Constructs aBatchUpdateException object initialized with a givencause andupdateCounts. TheSQLState is initialized tonull and the vendor code is initialized to 0. Thereason is initialized tonull ifcause==null or tocause.toString() ifcause!=null.

      Note: There is no validation ofupdateCounts for overflow and because of this it is recommended that you use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause).

      Parameters:
      updateCounts - an array ofint, with each element indicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure
      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6
      See Also:

    • BatchUpdateException

      public BatchUpdateException(String reason, int[] updateCounts,Throwable cause)
      Constructs aBatchUpdateException object initialized with a givenreason,cause andupdateCounts. TheSQLState is initialized tonull and the vendor code is initialized to 0.

      Note: There is no validation ofupdateCounts for overflow and because of this it is recommended that you use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause).

      Parameters:
      reason - a description of the exception
      updateCounts - an array ofint, with each element indicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure
      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6
      See Also:

    • BatchUpdateException

      public BatchUpdateException(String reason,String SQLState, int[] updateCounts,Throwable cause)
      Constructs aBatchUpdateException object initialized with a givenreason,SQLState,cause, andupdateCounts. The vendor code is initialized to 0.
      Parameters:
      reason - a description of the exception
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      updateCounts - an array ofint, with each element indicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure

      Note: There is no validation ofupdateCounts for overflow and because of this it is recommended that you use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause).

      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6
      See Also:

    • BatchUpdateException

      public BatchUpdateException(String reason,String SQLState, int vendorCode, int[] updateCounts,Throwable cause)
      Constructs aBatchUpdateException object initialized with a givenreason,SQLState,vendorCodecause andupdateCounts.
      Parameters:
      reason - a description of the error
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      vendorCode - an exception code used by a particular database vendor
      updateCounts - an array ofint, with each elementindicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure

      Note: There is no validation ofupdateCounts for overflow and because of this it is recommended that you use the constructorBatchUpdateException(String reason, String SQLState, int vendorCode, long []updateCounts, Throwable cause).

      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.6
      See Also:

    • BatchUpdateException

      public BatchUpdateException(String reason,String SQLState, int vendorCode, long[] updateCounts,Throwable cause)
      Constructs aBatchUpdateException object initialized with a givenreason,SQLState,vendorCodecause andupdateCounts.

      This constructor should be used when the returned update count may exceedInteger.MAX_VALUE.

      Parameters:
      reason - a description of the error
      SQLState - an XOPEN or SQL:2003 code identifying the exception
      vendorCode - an exception code used by a particular database vendor
      updateCounts - an array oflong, with each elementindicating the update count,Statement.SUCCESS_NO_INFO orStatement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count orStatement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure
      cause - the underlying reason for thisSQLException (which is saved for later retrieval by thegetCause() method); may be null indicating the cause is non-existent or unknown.
      Since:
      1.8

  • Method Details

    • getUpdateCounts

      public int[] getUpdateCounts()
      Retrieves the update count for each update statement in the batch update that executed successfully before this exception occurred. A driver that implements batch updates may or may not continue to process the remaining commands in a batch when one of the commands fails to execute properly. If the driver continues processing commands, the array returned by this method will have as many elements as there are commands in the batch; otherwise, it will contain an update count for each command that executed successfully before theBatchUpdateException was thrown.

      The possible return values for this method were modified for the Java 2 SDK, Standard Edition, version 1.3. This was done to accommodate the new option of continuing to process commands in a batch update after aBatchUpdateException object has been thrown.

      Returns:
      an array ofint containing the update counts for the updates that were executed successfully before this error occurred. Or, if the driver continues to process commands after an error, one of the following for every command in the batch:
      1. an update count
      2. Statement.SUCCESS_NO_INFO to indicate that the command executed successfully but the number of rows affected is unknown
      3. Statement.EXECUTE_FAILED to indicate that the command failed to execute successfully
      Since:
      1.3
      See Also:

    • getLargeUpdateCounts

      public long[] getLargeUpdateCounts()
      Retrieves the update count for each update statement in the batch update that executed successfully before this exception occurred. A driver that implements batch updates may or may not continue to process the remaining commands in a batch when one of the commands fails to execute properly. If the driver continues processing commands, the array returned by this method will have as many elements as there are commands in the batch; otherwise, it will contain an update count for each command that executed successfully before theBatchUpdateException was thrown.

      This method should be used whenStatement.executeLargeBatch is invoked and the returned update count may exceedInteger.MAX_VALUE.

      Returns:
      an array oflong containing the update counts for the updates that were executed successfully before this error occurred. Or, if the driver continues to process commands after an error, one of the following for every command in the batch:
      1. an update count
      2. Statement.SUCCESS_NO_INFO to indicate that the command executed successfully but the number of rows affected is unknown
      3. Statement.EXECUTE_FAILED to indicate that the command failed to execute successfully
      Since:
      1.8