APIdia Launch Partner
Top Description Fields Constructors Methods
java.sql

public Class BatchUpdateException

extends SQLException
Class Inheritance
Imports
java.io.IOException, .InvalidObjectException, .ObjectInputStream, .ObjectOutputStream, java.util.Arrays
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.

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

If Statement.executeLargeBatch method is invoked it is recommended that getLargeUpdateCounts be called instead of getUpdateCounts in order to avoid a possible overflow of the integer update count.

Since
1.2

Field Summary

Modifier and TypeField and Description
private long[]
longUpdateCounts

The array that describes the outcome of a batch execution.

private static final long
serialVersionUID

Hides java.sql.SQLException.serialVersionUID.

private int[]
updateCounts

The array that describes the outcome of a batch execution.

Constructor Summary

AccessConstructor and Description
public
BatchUpdateException(String
a description of the error
reason, String
an XOPEN or SQL:2003 code identifying the exception
SQLState, int
an exception code used by a particular database vendor
vendorCode, int[]
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
updateCounts)

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

public
BatchUpdateException(String
a description of the exception
reason, String
an XOPEN or SQL:2003 code identifying the exception
SQLState, int[]
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
updateCounts)

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

public
BatchUpdateException(String
a description of the exception
reason, int[]
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
updateCounts)

Constructs a BatchUpdateException object initialized with a given reason and updateCounts.

public
BatchUpdateException(int[]
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
updateCounts)

Constructs a BatchUpdateException object initialized with a given updateCounts.

public
BatchUpdateException()

Constructs a BatchUpdateException object.

public
BatchUpdateException(Throwable
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.
cause)

Constructs a BatchUpdateException object initialized with a given cause.

public
BatchUpdateException(int[]
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
updateCounts, Throwable
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.
cause)

Constructs a BatchUpdateException object initialized with a given cause and updateCounts.

public
BatchUpdateException(String
a description of the exception
reason, int[]
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
updateCounts, Throwable
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.
cause)

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

public
BatchUpdateException(String
a description of the exception
reason, String
an XOPEN or SQL:2003 code identifying the exception
SQLState, int[]
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

Note

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

updateCounts, Throwable
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.
cause)

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

public
BatchUpdateException(String
a description of the error
reason, String
an XOPEN or SQL:2003 code identifying the exception
SQLState, int
an exception code used by a particular database vendor
vendorCode, int[]
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

Note

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

updateCounts, Throwable
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.
cause)

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

public
BatchUpdateException(String
a description of the error
reason, String
an XOPEN or SQL:2003 code identifying the exception
SQLState, int
an exception code used by a particular database vendor
vendorCode, long[]
an array of long, 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
updateCounts, Throwable
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.
cause)

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

Method Summary

Modifier and TypeMethod and Description
private static long[]
copyUpdateCount(int[] uc)

private static int[]
copyUpdateCount(long[] uc)

public long[]

Returns:

an array of long 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
getLargeUpdateCounts()

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

public int[]

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
getUpdateCounts()

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

private void
readObject(ObjectInputStream
the ObjectInputStream to read from.
s)

Hides java.lang.Throwable.readObject.

readObject is called to restore the state of the BatchUpdateException from a stream.

private void
writeObject(ObjectOutputStream
the ObjectOutputStream to write to.
s)

Hides java.lang.Throwable.writeObject.

writeObject is called to save the state of the BatchUpdateException to a stream.

Inherited from java.sql.SQLException:
getErrorCodegetNextExceptiongetSQLStateiteratorsetNextException

Field Detail

longUpdateCountsback to summary
private long[] longUpdateCounts

The array that describes the outcome of a batch execution.

Since
1.8
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.sql.SQLException.serialVersionUID.

updateCountsback to summary
private int[] updateCounts

The array that describes the outcome of a batch execution.

Since
1.2

Constructor Detail

BatchUpdateExceptionback to summary
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.

Note

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

Parameters
reason:String

a description of the error

SQLState:String

an XOPEN or SQL:2003 code identifying the exception

vendorCode:int

an exception code used by a particular database vendor

updateCounts:int[]

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

Since
1.2
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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.

Note

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

Parameters
reason:String

a description of the exception

SQLState:String

an XOPEN or SQL:2003 code identifying the exception

updateCounts:int[]

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

Since
1.2
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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 vendor code is initialized to 0.

Note

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

Parameters
reason:String

a description of the exception

updateCounts:int[]

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

Since
1.2
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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.

Note

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

Parameters
updateCounts:int[]

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

Since
1.2
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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.

Since
1.2
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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:Throwable

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.

Since
1.6
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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.

Note

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

Parameters
updateCounts:int[]

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:Throwable

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.

Since
1.6
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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.

Note

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

Parameters
reason:String

a description of the exception

updateCounts:int[]

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:Throwable

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.

Since
1.6
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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:String

a description of the exception

SQLState:String

an XOPEN or SQL:2003 code identifying the exception

updateCounts:int[]

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

Note

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

cause:Throwable

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.

Since
1.6
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
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:String

a description of the error

SQLState:String

an XOPEN or SQL:2003 code identifying the exception

vendorCode:int

an exception code used by a particular database vendor

updateCounts:int[]

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

Note

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

cause:Throwable

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.

Since
1.6
See Also
BatchUpdateException(java.lang.String, java.lang.String, int, long[], java.lang.Throwable)
BatchUpdateExceptionback to summary
public BatchUpdateException(String reason, String SQLState, int vendorCode, long[] updateCounts, Throwable cause)

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

This constructor should be used when the returned update count may exceed Integer#MAX_VALUE.

Parameters
reason:String

a description of the error

SQLState:String

an XOPEN or SQL:2003 code identifying the exception

vendorCode:int

an exception code used by a particular database vendor

updateCounts:long[]

an array of long, 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:Throwable

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.

Since
1.8

Method Detail

copyUpdateCountback to summary
private static long[] copyUpdateCount(int[] uc)
copyUpdateCountback to summary
private static int[] copyUpdateCount(long[] uc)
getLargeUpdateCountsback to summary
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 the BatchUpdateException was thrown.

This method should be used when Statement.executeLargeBatch is invoked and the returned update count may exceed Integer#MAX_VALUE.

Returns:long[]

an array of long 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
getUpdateCountsback to summary
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:int[]

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
See Also
getLargeUpdateCounts()
readObjectback to summary
private void readObject(ObjectInputStream s) throws IOException, ClassNotFoundException

Hides java.lang.Throwable.readObject.

readObject is called to restore the state of the BatchUpdateException from a stream.

Parameters
s:ObjectInputStream

the ObjectInputStream to read from.

Exceptions
IOException:
if an I/O error occurs.
ClassNotFoundException:
if the class of a serialized object could not be found.
writeObjectback to summary
private void writeObject(ObjectOutputStream s) throws IOException

Hides java.lang.Throwable.writeObject.

writeObject is called to save the state of the BatchUpdateException to a stream.

Parameters
s:ObjectOutputStream

the ObjectOutputStream to write to.

Exceptions
IOException:
if an I/O error occurs.