BatchUpdateException

AI-generated Key Takeaways

• BatchUpdateException is a subclass of SQLException signaling errors during JDBC batch updates, providing update counts for successful commands before the error and potentially for all commands depending on the driver.

• Drivers may continue or halt batch processing after an error, impacting the update counts returned by getUpdateCounts(), which can include Statement.EXECUTE_FAILED for failures.

• BatchUpdateException offers constructors with varying levels of detail for the error reason, SQLState, vendor code, update counts, and underlying cause.

• getUpdateCounts() retrieves an array of integers representing update counts for each statement, with Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED potentially included based on driver behavior and command outcomes.

• The exception provides detailed information like reason, SQLState, vendor code, update counts, and cause to aid in diagnosing batch update issues.

public class BatchUpdateException extends SQLException

The subclass of SQLException 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.

Public Constructor Summary

	BatchUpdateException(String reason, String SQLState, int vendorCode, int[] updateCounts) Constructs a BatchUpdateException object initialized with a given reason, SQLState, vendorCode and updateCounts.
	BatchUpdateException(String reason, String SQLState, int[] updateCounts) Constructs a BatchUpdateException object initialized with a given reason, SQLState and updateCounts.
	BatchUpdateException(String reason, int[] updateCounts) Constructs a BatchUpdateException object initialized with a given reason and updateCounts.
	BatchUpdateException(int[] updateCounts) Constructs a BatchUpdateException object initialized with a given updateCounts.
	BatchUpdateException() Constructs a BatchUpdateException object.
	BatchUpdateException(Throwable cause) Constructs a BatchUpdateException object initialized with a given cause.
	BatchUpdateException(int[] updateCounts, Throwable cause) Constructs a BatchUpdateException object initialized with a given cause and updateCounts.
	BatchUpdateException(String reason, int[] updateCounts, Throwable cause) Constructs a BatchUpdateException object initialized with a given reason, cause and updateCounts.
	BatchUpdateException(String reason, String SQLState, int[] updateCounts, Throwable cause) Constructs a BatchUpdateException object initialized with a given reason, SQLState,cause, and updateCounts.
	BatchUpdateException(String reason, String SQLState, int vendorCode, int[] updateCounts, Throwable cause) Constructs a BatchUpdateException object initialized with a given reason, SQLState, vendorCode cause and updateCounts.

Public Method Summary

int[]

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

Inherited Method Summary

From class java.sql.SQLException

int	getErrorCode() Retrieves the vendor-specific exception code for this SQLException object.
SQLException	getNextException() Retrieves the exception chained to this SQLException object by setNextException(SQLException ex).
String	getSQLState() Retrieves the SQLState for this SQLException object.
Iterator<Throwable>	iterator() Returns an iterator over the chained SQLExceptions.
void	setNextException(SQLException ex) Adds an SQLException object to the end of the chain.

From class java.lang.Throwable

synchronized final void	addSuppressed(Throwable exception) Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
synchronized Throwable	fillInStackTrace() Fills in the execution stack trace.
synchronized Throwable	getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown.
String	getLocalizedMessage() Creates a localized description of this throwable.
String	getMessage() Returns the detail message string of this throwable.
StackTraceElement[]	getStackTrace() Provides programmatic access to the stack trace information printed by printStackTrace().
synchronized final Throwable[]	getSuppressed() Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.
synchronized Throwable	initCause(Throwable cause) Initializes the cause of this throwable to the specified value.
void	printStackTrace() Prints this throwable and its backtrace to the standard error stream.
void	printStackTrace(PrintWriter s) Prints this throwable and its backtrace to the specified print writer.
void	printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream.
void	setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
String	toString() Returns a short description of this throwable.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.lang.Iterable

void	forEach(Consumer<? super T> action) Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.
abstract Iterator<Throwable>	iterator() Returns an iterator over elements of type T.
Spliterator<Throwable>	spliterator() Creates a Spliterator over the elements described by this Iterable.

Public Constructors

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

Constructs a BatchUpdateException object initialized with a given reason, SQLState, vendorCode and updateCounts. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method.

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 of int, with each element indicating the update count, Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count or Statement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure

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

Constructs a BatchUpdateException object initialized with a given reason, SQLState and updateCounts. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method. 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 of int, with each element indicating the update count, Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count or Statement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure

public BatchUpdateException (String reason, int[] updateCounts)

Constructs a BatchUpdateException object initialized with a given reason and updateCounts. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method. The SQLState is initialized to null and the vender code is initialized to 0.

Parameters

reason	a description of the exception
updateCounts	an array of int, with each element indicating the update count, Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count or Statement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure

public BatchUpdateException (int[] updateCounts)

Constructs a BatchUpdateException object initialized with a given updateCounts. initialized by a call to the Throwable.initCause(java.lang.Throwable) method. The reason and SQLState are initialized to null and the vendor code is initialized to 0.

Parameters

updateCounts	an array of int, with each element indicating the update count, Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count or Statement.SUCCESS_NO_INFO for each SQL command in the batch prior to the failure for JDBC drivers that stop processing after a command failure

public BatchUpdateException ()

Constructs a BatchUpdateException object. The reason, SQLState and updateCounts are initialized to null and the vendor code is initialized to 0. The cause is not initialized, and may subsequently be initialized by a call to the Throwable.initCause(java.lang.Throwable) method.

public BatchUpdateException (Throwable cause)

Constructs a BatchUpdateException object initialized with a given cause. The SQLState and updateCounts are initialized to null and the vendor code is initialized to 0. The reason is initialized to null if cause==null or to cause.toString() if cause!=null.

Parameters

cause	the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

public BatchUpdateException (int[] updateCounts, Throwable cause)

Constructs a BatchUpdateException object initialized with a given cause and updateCounts. The SQLState is initialized to null and the vendor code is initialized to 0. The reason is initialized to null if cause==null or to cause.toString() if cause!=null.

Parameters

updateCounts	an array of int, with each element indicating the update count, Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count or Statement.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 this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

public BatchUpdateException (String reason, int[] updateCounts, Throwable cause)

Constructs a BatchUpdateException object initialized with a given reason, cause and updateCounts. The SQLState is initialized to null and the vendor code is initialized to 0.

Parameters

reason	a description of the exception
updateCounts	an array of int, with each element indicating the update count, Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count or Statement.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 this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

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

Constructs a BatchUpdateException object initialized with a given reason, SQLState,cause, and updateCounts. 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 of int, with each element indicating the update count, Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count or Statement.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 this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

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

Constructs a BatchUpdateException object initialized with a given reason, SQLState, vendorCode cause and updateCounts.

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 of int, with each element indicating the update count, Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED for each SQL command in the batch for JDBC drivers that continue processing after a command failure; an update count or Statement.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 this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

Public Methods

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