java.sql
Class BatchUpdateException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.sql.SQLException
              java.sql.BatchUpdateException

All Implemented Interfaces:

Serializable

public class BatchUpdateException

extends SQLException

An exception thrown when an error occurs during a batch update operation. In addition to the information provided by SQLException, a BatchUpdateException 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 a BatchUpdateException 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 method BatchUpdateException.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 is Statement.EXECUTE_FAILED.

Since:

1.2

See Also:

Serialized Form

Field Summary

private int[]

updateCounts The array that describes the outcome of a batch execution.

Fields inherited from class java.sql.SQLException

Fields inherited from class java.lang.Exception

Fields inherited from class java.lang.Throwable

Constructor Summary

BatchUpdateException()
Constructs a BatchUpdateException object with the reason, SQLState, and update count initialized to null and the vendor code initialized to 0.

BatchUpdateException(int[] updateCounts)
Constructs a BatchUpdateException initialized to null for the reason and SQLState and 0 for the vendor code.

BatchUpdateException(String reason, int[] updateCounts)
Constructs a BatchUpdateException initialized with reason, updateCounts and null for the SQLState and 0 for the vendorCode.

BatchUpdateException(String reason, String SQLState, int[] updateCounts)
Constructs a BatchUpdateException initialized with the given arguments (reason, SQLState, and updateCounts) and 0 for the vendor code.

BatchUpdateException(String reason, String SQLState, int vendorCode, int[] updateCounts)
Constructs a fully-specified BatchUpdateException object, initializing it with the given values.

Method Summary

int[]

getUpdateCounts() Retrieves the update count for each update statement in the batch update that executed successfully before this exception occurred.

Methods inherited from class java.sql.SQLException

getErrorCode, getNextException, getSQLState, setNextException

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

updateCounts

private int[] updateCounts

The array that describes the outcome of a batch execution.

Since:

1.2

Constructor Detail

BatchUpdateException

public BatchUpdateException(String reason,
                            String SQLState,
                            int vendorCode,
                            int[] updateCounts)

Constructs a fully-specified BatchUpdateException object, initializing it with the given values.

Parameters:

reason - a description of the error

SQLState - an X/OPEN code identifying the error

vendorCode - an exception code used by a particular database vendor

updateCounts - an array of int, with each element indicating the update count for a SQL command that executed successfully before the exception was thrown

Since:

1.2

BatchUpdateException

public BatchUpdateException(String reason,
                            String SQLState,
                            int[] updateCounts)

Constructs a BatchUpdateException initialized with the given arguments (reason, SQLState, and updateCounts) and 0 for the vendor code.

Parameters:

reason - a description of the exception

SQLState - an X/OPEN code identifying the exception

updateCounts - an array of int, with each element indicating the update count for a SQL command that executed successfully before the exception was thrown

Since:

1.2

BatchUpdateException

public BatchUpdateException(String reason,
                            int[] updateCounts)

Constructs a BatchUpdateException initialized with reason, updateCounts and null for the SQLState and 0 for the vendorCode.

Parameters:

reason - a description of the exception

updateCounts - an array of int, with each element indicating the update count for a SQL command that executed successfully before the exception was thrown

Since:

1.2

BatchUpdateException

public BatchUpdateException(int[] updateCounts)

Constructs a BatchUpdateException initialized to null for the reason and SQLState and 0 for the vendor code.

Parameters:

updateCounts - an array of int, with each element indicating the update count for a SQL command that executed successfully before the exception was thrown

Since:

1.2

BatchUpdateException

public BatchUpdateException()

Constructs a BatchUpdateException object with the reason, SQLState, and update count initialized to null and the vendor code initialized to 0.

Since:

1.2

Method Detail

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 the BatchUpdateException 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 a BatchUpdateException object has been thrown.

Returns:

an array of int 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