java.sql (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Package java.sql

Interface Summary
Array	The mapping in the Java programming language for the SQL type `ARRAY`.
Blob	The representation (mapping) in the Java^TM programming language of an SQL `BLOB` value.
CallableStatement	The interface used to execute SQL stored procedures.
Clob	The mapping in the Java^TM programming language for the SQL `CLOB` type.
Connection	A connection (session) with a specific database.
DatabaseMetaData	Comprehensive information about the database as a whole.
Driver	The interface that every driver class must implement.
NClob	The mapping in the Java^TM programming language for the SQL `NCLOB` type.
ParameterMetaData	An object that can be used to get information about the types and properties for each parameter marker in a `PreparedStatement` object.
PreparedStatement	An object that represents a precompiled SQL statement.
Ref	The mapping in the Java programming language of an SQL `REF` value, which is a reference to an SQL structured type value in the database.
ResultSet	A table of data representing a database result set, which is usually generated by executing a statement that queries the database.
ResultSetMetaData	An object that can be used to get information about the types and properties of the columns in a `ResultSet` object.
RowId	The representation (mapping) in the Java programming language of an SQL ROWID value.
Savepoint	The representation of a savepoint, which is a point within the current transaction that can be referenced from the `Connection.rollback` method.
SQLData	The interface used for the custom mapping of an SQL user-defined type (UDT) to a class in the Java programming language.
SQLInput	An input stream that contains a stream of values representing an instance of an SQL structured type or an SQL distinct type.
SQLOutput	The output stream for writing the attributes of a user-defined type back to the database.
SQLXML	The mapping in the JavaTM programming language for the SQL XML type.
Statement	The object used for executing a static SQL statement and returning the results it produces.
Struct	The standard mapping in the Java programming language for an SQL structured type.
Wrapper	Interface for JDBC classes which provide the ability to retrieve the delegate instance when the instance in question is in fact a proxy class.

Interface Summary

Array

The mapping in the Java programming language for the SQL type ARRAY.

Blob

The representation (mapping) in the Java^TM programming language of an SQL BLOB value.

CallableStatement

The interface used to execute SQL stored procedures.

Clob

The mapping in the Java^TM programming language for the SQL CLOB type.

Connection

A connection (session) with a specific database.

DatabaseMetaData

Comprehensive information about the database as a whole.

Driver

The interface that every driver class must implement.

NClob

The mapping in the Java^TM programming language for the SQL NCLOB type.

ParameterMetaData

An object that can be used to get information about the types and properties for each parameter marker in a PreparedStatement object.

PreparedStatement

An object that represents a precompiled SQL statement.

Ref

The mapping in the Java programming language of an SQL REF value, which is a reference to an SQL structured type value in the database.

ResultSet

A table of data representing a database result set, which is usually generated by executing a statement that queries the database.

ResultSetMetaData

An object that can be used to get information about the types and properties of the columns in a ResultSet object.

RowId

The representation (mapping) in the Java programming language of an SQL ROWID value.

Savepoint

The representation of a savepoint, which is a point within the current transaction that can be referenced from the Connection.rollback method.

SQLData

The interface used for the custom mapping of an SQL user-defined type (UDT) to a class in the Java programming language.

SQLInput

An input stream that contains a stream of values representing an instance of an SQL structured type or an SQL distinct type.

SQLOutput

The output stream for writing the attributes of a user-defined type back to the database.

SQLXML

The mapping in the JavaTM programming language for the SQL XML type.

Statement

The object used for executing a static SQL statement and returning the results it produces.

Struct

The standard mapping in the Java programming language for an SQL structured type.

Wrapper

Interface for JDBC classes which provide the ability to retrieve the delegate instance when the instance in question is in fact a proxy class.

Class Summary
Date	A thin wrapper around a millisecond value that allows JDBC to identify this as an SQL `DATE` value.
DriverManager	The basic service for managing a set of JDBC drivers. NOTE: The `DataSource` interface, new in the JDBC 2.0 API, provides another way to connect to a data source.
DriverPropertyInfo	Driver properties for making a connection.
SQLPermission	The permission for which the `SecurityManager` will check when code that is running in an applet calls the `DriverManager.setLogWriter` method or the `DriverManager.setLogStream` (deprecated) method.
Time	A thin wrapper around the `java.util.Date` class that allows the JDBC API to identify this as an SQL `TIME` value.
Timestamp	A thin wrapper around `java.util.Date` that allows the JDBC API to identify this as an SQL `TIMESTAMP` value.
Types	The class that defines the constants that are used to identify generic SQL types, called JDBC types.

Class Summary

Date

A thin wrapper around a millisecond value that allows JDBC to identify this as an SQL DATE value.

DriverManager

The basic service for managing a set of JDBC drivers.
NOTE: The DataSource interface, new in the JDBC 2.0 API, provides another way to connect to a data source.

DriverPropertyInfo

Driver properties for making a connection.

SQLPermission

The permission for which the SecurityManager will check when code that is running in an applet calls the DriverManager.setLogWriter method or the DriverManager.setLogStream (deprecated) method.

Time

A thin wrapper around the java.util.Date class that allows the JDBC API to identify this as an SQL TIME value.

Timestamp

A thin wrapper around java.util.Date that allows the JDBC API to identify this as an SQL TIMESTAMP value.

Types

The class that defines the constants that are used to identify generic SQL types, called JDBC types.

Enum Summary
ClientInfoStatus	Enumeration for status of the reason that a property could not be set via a call to `Connection.setClientInfo`
RowIdLifetime	Enumeration for RowId life-time values.

Enum Summary

ClientInfoStatus

Enumeration for status of the reason that a property could not be set via a call to Connection.setClientInfo

RowIdLifetime

Enumeration for RowId life-time values.

Exception Summary
BatchUpdateException	The subclass of java.sql.SQLException thrown when an error occurs during a batch update operation.
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`.
SQLClientInfoException	The subclass of java.sql.SQLException is thrown when one or more client info properties could not be set on a `Connection`.
SQLDataException	The subclass of java.sql.SQLException thrown when the SQLState class value is '22'.
SQLException	An exception that provides information on a database access error or other errors.
SQLFeatureNotSupportedException	The subclass of java.sql.SQLException thrown when the SQLState class value is '0A' ( the value is 'zero' A).
SQLIntegrityConstraintViolationException	The subclass of java.sql.SQLException thrown when the SQLState class value is '23'.
SQLInvalidAuthorizationSpecException	The subclass of java.sql.SQLException thrown when the SQLState class value is '28'.
SQLNonTransientConnectionException	The subclass of java.sql.SQLException thrown for the SQLState class value '08', representing that the connection operation that failed will not succeed when the operation is retried without the cause of the failure being corrected.
SQLNonTransientException	The subclass of java.sql.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 java.sql.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.
SQLSyntaxErrorException	The subclass of java.sql.SQLException thrown when the SQLState class value is '42'.
SQLTimeoutException	The subclass of java.sql.SQLException thrown when the timeout specified by `Statement` has expired.
SQLTransactionRollbackException	The subclass of java.sql.SQLException thrown when the SQLState class value is '40'.
SQLTransientConnectionException	The subclass of java.sql.SQLException for the SQLState class value '08', representing that the connection operation that failed might be able to succeed when the operation is retried without any application-level changes.
SQLTransientException	The subclass of java.sql.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.

Exception Summary

BatchUpdateException

The subclass of java.sql.SQLException thrown when an error occurs during a batch update operation.

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.

SQLClientInfoException

The subclass of java.sql.SQLException is thrown when one or more client info properties could not be set on a Connection.

SQLDataException

The subclass of java.sql.SQLException thrown when the SQLState class value is '22'.

SQLException

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

SQLFeatureNotSupportedException

The subclass of java.sql.SQLException thrown when the SQLState class value is '0A' ( the value is 'zero' A).

SQLIntegrityConstraintViolationException

The subclass of java.sql.SQLException thrown when the SQLState class value is '23'.

SQLInvalidAuthorizationSpecException

The subclass of java.sql.SQLException thrown when the SQLState class value is '28'.

SQLNonTransientConnectionException

The subclass of java.sql.SQLException thrown for the SQLState class value '08', representing that the connection operation that failed will not succeed when the operation is retried without the cause of the failure being corrected.

SQLNonTransientException

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

SQLSyntaxErrorException

The subclass of java.sql.SQLException thrown when the SQLState class value is '42'.

SQLTimeoutException

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

SQLTransactionRollbackException

The subclass of java.sql.SQLException thrown when the SQLState class value is '40'.

SQLTransientConnectionException

The subclass of java.sql.SQLException for the SQLState class value '08', representing that the connection operation that failed might be able to succeed when the operation is retried without any application-level changes.

SQLTransientException

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

This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:

The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.