SQLException (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
    - - java.sql.SQLException
All Implemented Interfaces:
Serializable, Iterable<Throwable>
Direct Known Subclasses:
BatchUpdateException, RowSetWarning, SerialException, SQLClientInfoException, SQLNonTransientException, SQLRecoverableException, SQLTransientException, SQLWarning, SyncFactoryException, SyncProviderException

public class SQLException
extends Exception
implements Iterable<Throwable>
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 getMessage.
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.
See Also:
Serialized Form

Constructor Summary

Constructors

Constructor	Description
SQLException()	Constructs a SQLException object.
SQLException(String reason)	Constructs a SQLException object with a givenreason.
SQLException(String reason,String SQLState)	Constructs a SQLException object with a givenreason and SQLState.
SQLException(String reason,String SQLState, int vendorCode)	Constructs a SQLException object with a givenreason, SQLState andvendorCode.
SQLException(String reason,String sqlState, int vendorCode,Throwable cause)	Constructs a SQLException object with a givenreason, SQLState, vendorCode and cause.
SQLException(String reason,String sqlState,Throwable cause)	Constructs a SQLException object with a givenreason, SQLState and cause.
SQLException(String reason,Throwable cause)	Constructs a SQLException object with a givenreason and cause.
SQLException(Throwable cause)	Constructs a SQLException object with a givencause.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
int	getErrorCode()	Retrieves the vendor-specific exception code for this SQLException object.
SQLException	getNextException()	Retrieves the exception chained to thisSQLException 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.

   * ### Methods inherited from class java.lang.[Throwable](../../java/lang/Throwable.html "class in java.lang")  
   `[addSuppressed](../../java/lang/Throwable.html#addSuppressed-java.lang.Throwable-), [fillInStackTrace](../../java/lang/Throwable.html#fillInStackTrace--), [getCause](../../java/lang/Throwable.html#getCause--), [getLocalizedMessage](../../java/lang/Throwable.html#getLocalizedMessage--), [getMessage](../../java/lang/Throwable.html#getMessage--), [getStackTrace](../../java/lang/Throwable.html#getStackTrace--), [getSuppressed](../../java/lang/Throwable.html#getSuppressed--), [initCause](../../java/lang/Throwable.html#initCause-java.lang.Throwable-), [printStackTrace](../../java/lang/Throwable.html#printStackTrace--), [printStackTrace](../../java/lang/Throwable.html#printStackTrace-java.io.PrintStream-), [printStackTrace](../../java/lang/Throwable.html#printStackTrace-java.io.PrintWriter-), [setStackTrace](../../java/lang/Throwable.html#setStackTrace-java.lang.StackTraceElement:A-), [toString](../../java/lang/Throwable.html#toString--)`  
   * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone--), [equals](../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [hashCode](../../java/lang/Object.html#hashCode--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`  
   * ### Methods inherited from interface java.lang.[Iterable](../../java/lang/Iterable.html "interface in java.lang")  
   `[forEach](../../java/lang/Iterable.html#forEach-java.util.function.Consumer-), [spliterator](../../java/lang/Iterable.html#spliterator--)`

Constructor Detail

 * #### SQLException  
 public SQLException([String](../../java/lang/String.html "class in java.lang") reason,  
                     [String](../../java/lang/String.html "class in java.lang") 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)](../../java/lang/Throwable.html#initCause-java.lang.Throwable-) method.  
 Parameters:  
 `reason` \- a description of the exception  
 `SQLState` \- an XOPEN or SQL:2003 code identifying the exception  
 `vendorCode` \- a database vendor-specific exception code  
 * #### SQLException  
 public SQLException([String](../../java/lang/String.html "class in java.lang") reason,  
                     [String](../../java/lang/String.html "class in java.lang") 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)](../../java/lang/Throwable.html#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  
 * #### SQLException  
 public SQLException([String](../../java/lang/String.html "class in java.lang") reason)  
 Constructs a `SQLException` object with a given`reason`. The `SQLState` is 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)](../../java/lang/Throwable.html#initCause-java.lang.Throwable-) method.  
 Parameters:  
 `reason` \- a description of the exception  
 * #### SQLException  
 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)](../../java/lang/Throwable.html#initCause-java.lang.Throwable-) method.  
 * #### SQLException  
 public SQLException([Throwable](../../java/lang/Throwable.html "class in java.lang") 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` \- 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  
 * #### SQLException  
 public SQLException([String](../../java/lang/String.html "class in java.lang") reason,  
                     [Throwable](../../java/lang/Throwable.html "class in java.lang") 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` \- a description of the exception.  
 `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.  
 Since:  
 1.6  
 * #### SQLException  
 public SQLException([String](../../java/lang/String.html "class in java.lang") reason,  
                     [String](../../java/lang/String.html "class in java.lang") sqlState,  
                     [Throwable](../../java/lang/Throwable.html "class in java.lang") cause)  
 Constructs a `SQLException` object with a given`reason`, `SQLState` and `cause`. The vendor code is initialized to 0.  
 Parameters:  
 `reason` \- a description of the exception.  
 `sqlState` \- an XOPEN or SQL:2003 code identifying the exception  
 `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.  
 Since:  
 1.6  
 * #### SQLException  
 public SQLException([String](../../java/lang/String.html "class in java.lang") reason,  
                     [String](../../java/lang/String.html "class in java.lang") sqlState,  
                     int vendorCode,  
                     [Throwable](../../java/lang/Throwable.html "class in java.lang") cause)  
 Constructs a `SQLException` object with a given`reason`, `SQLState`, `vendorCode` and `cause`.  
 Parameters:  
 `reason` \- a description of the exception  
 `sqlState` \- an XOPEN or SQL:2003 code identifying the exception  
 `vendorCode` \- a database vendor-specific exception code  
 `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.  
 Since:  
 1.6

Method Detail

* #### getSQLState  
public [String](../../java/lang/String.html "class in java.lang") getSQLState()  
Retrieves the SQLState for this `SQLException` object.  
Returns:  
the SQLState value  
* #### getErrorCode  
public int getErrorCode()  
Retrieves the vendor-specific exception code for this `SQLException` object.  
Returns:  
the vendor's error code  
* #### getNextException  
public [SQLException](../../java/sql/SQLException.html "class in java.sql") getNextException()  
Retrieves the exception chained to this`SQLException` object by setNextException(SQLException ex).  
Returns:  
the next `SQLException` object in the chain;`null` if there are none  
See Also:  
[setNextException(java.sql.SQLException)](../../java/sql/SQLException.html#setNextException-java.sql.SQLException-)  
* #### setNextException  
public void setNextException([SQLException](../../java/sql/SQLException.html "class in java.sql") ex)  
Adds an `SQLException` object to the end of the chain.  
Parameters:  
`ex` \- the new exception that will be added to the end of the `SQLException` chain  
See Also:  
[getNextException()](../../java/sql/SQLException.html#getNextException--)  
* #### iterator  
public [Iterator](../../java/util/Iterator.html "interface in java.util")<[Throwable](../../java/lang/Throwable.html "class in java.lang")> iterator()  
Returns an iterator over the chained SQLExceptions. The iterator will be used to iterate over each SQLException and its underlying cause (if any).  
Specified by:  
`[iterator](../../java/lang/Iterable.html#iterator--)` in interface `[Iterable](../../java/lang/Iterable.html "interface in java.lang")<[Throwable](../../java/lang/Throwable.html "class in java.lang")>`  
Returns:  
an iterator over the chained SQLExceptions and causes in the proper order  
Since:  
1.6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

SQLException (Java Platform SE 8 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail