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 class BatchUpdateException
extends SQLException
implements Serializable

This exception is thrown if a problem occurs during a batch update operation.

A BatchUpdateException provides additional information about the problem that occurred, compared with a standard SQLException. It supplies update counts for successful commands which were executed before the exception was encountered.

The element order in the array of update counts matches the order that the commands were added to the batch operation.

Once a batch update command fails and a BatchUpdateException is thrown, the JDBC driver may continue processing the remaining commands in the batch. If the driver does process more commands after the problem occurs, the array returned by BatchUpdateException.getUpdateCounts has an element for every command in the batch, not only those that executed successfully. In this case, the array element for any command which encountered a problem is set to Statement.EXECUTE_FAILED.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BatchUpdateException()	Creates a default BatchUpdateException with the parameters reason, SQLState, and update counts set to null and the vendor code set to 0.
BatchUpdateException(int[] updateCounts)	Creates a BatchUpdateException with the updateCounts set to the supplied value.
BatchUpdateException(int[] updateCounts, Throwable cause)	Creates an BatchUpdateException object.
BatchUpdateException(String reason, int[] updateCounts)	Creates a BatchUpdateException with the updateCounts and reason set to the supplied values.
BatchUpdateException(String reason, int[] updateCounts, Throwable cause)	Creates an BatchUpdateException object.
BatchUpdateException(String reason, String SQLState, int[] updateCounts)	Creates a BatchUpdateException with the reason, SQLState and updateCounts set to the supplied values.
BatchUpdateException(String reason, String SQLState, int[] updateCounts, Throwable cause)	Creates an BatchUpdateException object.
BatchUpdateException(String reason, String SQLState, int vendorCode, int[] updateCounts)	Creates a BatchUpdateException for the case where all relevant information is provided.
BatchUpdateException(String reason, String SQLState, int vendorCode, int[] updateCounts, Throwable cause)	Creates an BatchUpdateException object.
BatchUpdateException(Throwable cause)	Creates an BatchUpdateException object.

Method Summary

Modifier and Type	Method	Description
int[]	getUpdateCounts()	Gets the update count array giving status information for every command that was attempted in the batch.

Methods inherited from class java.sql.SQLException

getErrorCode, getNextException, getSQLState, iterator, setNextException

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

BatchUpdateException

public BatchUpdateException()

Creates a default BatchUpdateException with the parameters reason, SQLState, and update counts set to null and the vendor code set to 0.

BatchUpdateException

public BatchUpdateException(Throwable cause)

Creates an BatchUpdateException object. The reason is set to null if cause == null otherwise to cause.toString(), and the cause Throwable object is set to the given cause Throwable object.

Parameters:

cause - the Throwable object for the underlying reason this SQLException

Since:

1.6

BatchUpdateException

public BatchUpdateException(int[] updateCounts,
Throwable cause)

Creates an BatchUpdateException object. The Reason string is set to the null if cause == null otherwise to cause.toString(), and the cause Throwable object is set to the given cause Throwable object. SQLState is initialized to null while vendorCode is zero.

Parameters:

cause - the Throwable object for the underlying reason this SQLException

Since:

1.6

BatchUpdateException

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

Creates an BatchUpdateException object. The cause Throwable object is set to the given cause Throwable object. SQLState is initialized to null while vendorCode is zero.

Parameters:

cause - the Throwable object for the underlying reason this SQLException

Since:

1.6

BatchUpdateException

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

Creates an BatchUpdateException object. The cause Throwable object is set to the given cause Throwable object and the updateCounts array set to the int array parameter. SQLState is initialized to null while vendorCode is zero.

Parameters:

cause - the Throwable object for the underlying reason this SQLException

Since:

1.6

BatchUpdateException

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

Creates an BatchUpdateException object. The cause Throwable object is set to the given cause Throwable object and the updateCounts array set to the int array parameter. VendorCode is set to the given vendorCode. SQLState is initialized to null while vendorCode is zero.

Parameters:

cause - the Throwable object for the underlying reason this SQLException

Since:

1.6

BatchUpdateException

public BatchUpdateException(int[] updateCounts)

Creates a BatchUpdateException with the updateCounts set to the supplied value. All other fields are set to their default values.

Parameters:

updateCounts - the array of updateCounts giving the number of successful updates (or another status code) for each command in the batch that was attempted.

BatchUpdateException

public BatchUpdateException(String reason,
int[] updateCounts)

Creates a BatchUpdateException with the updateCounts and reason set to the supplied values. All other fields are set to their default values.

Parameters:

reason - the message providing information about the source of this exception.

updateCounts - the array of updateCounts giving the number of successful updates (or another status code) for each command in the batch that was attempted.

BatchUpdateException

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

Creates a BatchUpdateException with the reason, SQLState and updateCounts set to the supplied values. All other fields are set to their default values.

Parameters:

reason - the message providing information about the source of this exception.

SQLState - the X/OPEN value to use for the SQLState

updateCounts - the array of updateCounts giving the number of successful updates (or another status code) for each command in the batch that was attempted.

BatchUpdateException

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

Creates a BatchUpdateException for the case where all relevant information is provided.

Parameters:

reason - the message providing information about the source of this exception.

SQLState - the X/OPEN value to use for the SQLState.

vendorCode - the value to use for the vendor error code.

updateCounts - the array of updateCounts giving the number of successful updates (or another status code) for each command in the batch that was attempted.

Method Details

getUpdateCounts

public int[] getUpdateCounts()

Gets the update count array giving status information for every command that was attempted in the batch.

If a batch update command fails and a BatchUpdateException is thrown, the JDBC driver may continue processing the remaining commands in the batch. If the driver does so, the array returned by BatchUpdateException.getUpdateCounts has an element for every command in the batch, not only those that executed successfully. In this case, the array element for any command which encountered a problem is set to Statement.EXECUTE_FAILED.

Returns:

an array that contains the successful update counts, before this exception was thrown. Alternatively, if the driver continues to process commands following an error, for each successive command there is a corresponding element in the array giving one of the following status values:

1. the number of successful updates
2. Statement.SUCCESS_NO_INFO indicating that the command completed successfully, but the amount of altered rows is unknown.
3. Statement.EXECUTE_FAILED indicating that the command was unsuccessful.