Added in API level 1

SQLException

public class SQLException
extends Exception implements Iterable<Throwable>

java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ java.sql.SQLException
BatchUpdateException The subclass of SQLException thrown when an error occurs during a batch update operation. 
SQLClientInfoException The subclass of SQLException is thrown when one or more client info properties could not be set on a Connection
SQLNonTransientException The subclass of SQLException thrown when an instance where a retry of the same operation would fail unless the cause of the SQLException is corrected. 
SQLRecoverableException The subclass of SQLException thrown in situations where a previously failed operation might be able to succeed if the application performs some recovery steps and retries the entire transaction or in the case of a distributed transaction, the transaction branch. 
SQLTransientException The subclass of SQLException is thrown in situations where a previoulsy failed operation might be able to succeed when the operation is retried without any intervention by application-level functionality. 
SQLWarning

An exception that provides information on database access warnings. 

DataTruncation An exception thrown as a DataTruncation exception (on writes) or reported as a DataTruncation warning (on reads) when a data values is unexpectedly truncated for reasons other than its having execeeded MaxFieldSize
SQLDataException The subclass of SQLException thrown when the SQLState class value is '22', or under vendor-specified conditions. 
SQLFeatureNotSupportedException The subclass of SQLException thrown when the SQLState class value is '0A' ( the value is 'zero' A). 
SQLIntegrityConstraintViolationException The subclass of SQLException thrown when the SQLState class value is '23', or under vendor-specified conditions. 
SQLInvalidAuthorizationSpecException The subclass of SQLException thrown when the SQLState class value is '28', or under vendor-specified conditions. 
SQLNonTransientConnectionException The subclass of SQLException thrown for the SQLState class value '08', or under vendor-specified conditions. 
SQLSyntaxErrorException The subclass of SQLException thrown when the SQLState class value is '42', or under vendor-specified conditions. 
SQLTimeoutException

The subclass of SQLException thrown when the timeout specified by Statement has expired. 

SQLTransactionRollbackException The subclass of SQLException thrown when the SQLState class value is '40', or under vendor-specified conditions. 
SQLTransientConnectionException The subclass of SQLException for the SQLState class value '08', or under vendor-specified conditions. 


An exception that provides information on a database access error or other errors.

Each SQLException provides several kinds of information:

  • a string describing the error. This is used as the Java Exception message, available via the method getMesasge.
  • a "SQLstate" string, which follows either the XOPEN SQLstate conventions or the SQL:2003 conventions. The values of the SQLState string are described in the appropriate spec. The DatabaseMetaData method getSQLStateType can be used to discover whether the driver returns the XOPEN type or the SQL:2003 type.
  • an integer error code that is specific to each vendor. Normally this will be the actual error code returned by the underlying database.
  • a chain to a next Exception. This can be used to provide additional error information.
  • the causal relationship, if any for this SQLException.

Summary

Public constructors

SQLException()

Constructs a SQLException object.

SQLException(String reason)

Constructs a SQLException object with a given reason.

SQLException(String reason, String SQLState)

Constructs a SQLException object with a given reason and SQLState.

SQLException(String reason, String SQLState, int vendorCode)

Constructs a SQLException object with a given reason, SQLState and vendorCode.

SQLException(String reason, String sqlState, int vendorCode, Throwable cause)

Constructs a SQLException object with a given reason, SQLState, vendorCode and cause.

SQLException(String reason, String sqlState, Throwable cause)

Constructs a SQLException object with a given reason, SQLState and cause.

SQLException(String reason, Throwable cause)

Constructs a SQLException object with a given reason and cause.

SQLException(Throwable cause)

Constructs a SQLException object with a given cause.

Public methods

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.

Inherited methods

final void addSuppressed(Throwable exception)

Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.

Throwable fillInStackTrace()

Fills in the execution stack trace.

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

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.

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.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

default 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.

default Spliterator<Throwable> spliterator()

Creates a Spliterator over the elements described by this Iterable.

Public constructors

SQLException

Added in API level 1
public SQLException ()

Constructs a SQLException object. The reason, SQLState 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.

SQLException

Added in API level 1
public SQLException (String reason)

Constructs a SQLException object with a given reason. The SQLState is initialized to null and the vender 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.

Parameters
reason String: a description of the exception

SQLException

Added in API level 1
public SQLException (String reason, 
                String SQLState)

Constructs a SQLException object with a given reason and SQLState. 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 String: a description of the exception

SQLState String: an XOPEN or SQL:2003 code identifying the exception

SQLException

Added in API level 1
public SQLException (String reason, 
                String SQLState, 
                int vendorCode)

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

Parameters
reason String: a description of the exception

SQLState String: an XOPEN or SQL:2003 code identifying the exception

vendorCode int: a database vendor-specific exception code

SQLException

Added in API level 9
public SQLException (String reason, 
                String sqlState, 
                int vendorCode, 
                Throwable cause)

Constructs a SQLException object with a given reason, SQLState, vendorCode and cause.

Parameters
reason String: a description of the exception

sqlState String: an XOPEN or SQL:2003 code identifying the exception

vendorCode int: a database vendor-specific exception code

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.

SQLException

Added in API level 9
public SQLException (String reason, 
                String sqlState, 
                Throwable cause)

Constructs a SQLException object with a given reason, SQLState and cause. 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

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.

SQLException

Added in API level 9
public SQLException (String reason, 
                Throwable cause)

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

Parameters
reason String: a description of the exception.

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.

SQLException

Added in API level 9
public SQLException (Throwable cause)

Constructs a SQLException object with a given cause. 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
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.

Public methods

getErrorCode

Added in API level 1
public int getErrorCode ()

Retrieves the vendor-specific exception code for this SQLException object.

Returns
int the vendor's error code

getNextException

Added in API level 1
public SQLException getNextException ()

Retrieves the exception chained to this SQLException object by setNextException(SQLException ex).

Returns
SQLException the next SQLException object in the chain; null if there are none

getSQLState

Added in API level 1
public String getSQLState ()

Retrieves the SQLState for this SQLException object.

Returns
String the SQLState value

iterator

Added in API level 9
public Iterator<Throwable> iterator ()

Returns an iterator over the chained SQLExceptions. The iterator will be used to iterate over each SQLException and its underlying cause (if any).

Returns
Iterator<Throwable> an iterator over the chained SQLExceptions and causes in the proper order

setNextException

Added in API level 1
public void setNextException (SQLException ex)

Adds an SQLException object to the end of the chain.

Parameters
ex SQLException: the new exception that will be added to the end of the SQLException chain

See also: