Overview Summary


Package java.sql

Provides the API for accessing and processing data stored in a data source (usually a relational database) using the JavaTM programming language.

See:
          Description

Interface Summary
ArrayThe mapping in the Java programming language for the SQL type ARRAY.
BlobThe representation (mapping) in the JavaTM programming language of an SQL BLOB value.
CallableStatementThe interface used to execute SQL stored procedures.
ClobThe mapping in the JavaTM programming language for the SQL CLOB type.
ConnectionA connection (session) with a specific database.
DatabaseMetaDataComprehensive information about the database as a whole.
DriverThe interface that every driver class must implement.
NClobThe mapping in the JavaTM programming language for the SQL NCLOB type.
ParameterMetaDataAn object that can be used to get information about the types and properties for each parameter marker in a PreparedStatement object.
PreparedStatementAn object that represents a precompiled SQL statement.
RefThe mapping in the Java programming language of an SQL REF value, which is a reference to an SQL structured type value in the database.
ResultSetA table of data representing a database result set, which is usually generated by executing a statement that queries the database.
ResultSetMetaDataAn object that can be used to get information about the types and properties of the columns in a ResultSet object.
RowIdThe representation (mapping) in the Java programming language of an SQL ROWID value.
SavepointThe representation of a savepoint, which is a point within the current transaction that can be referenced from the Connection.rollback method.
SQLDataThe interface used for the custom mapping of an SQL user-defined type (UDT) to a class in the Java programming language.
SQLInputAn input stream that contains a stream of values representing an instance of an SQL structured type or an SQL distinct type.
SQLOutputThe output stream for writing the attributes of a user-defined type back to the database.
SQLTypeAn object that is used to identify a generic SQL type, called a JDBC type or a vendor specific data type.
SQLXMLThe mapping in the JavaTM programming language for the SQL XML type.
StatementThe object used for executing a static SQL statement and returning the results it produces.
StructThe standard mapping in the Java programming language for an SQL structured type.
WrapperInterface 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
DateA thin wrapper around a millisecond value that allows JDBC to identify this as an SQL DATE value.
DriverManagerThe 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.
DriverPropertyInfoDriver properties for making a connection.
SQLPermissionThe permission for which the SecurityManager will check when code that is running in an applet, or an application with a SecurityManager enabled, calls the DriverManager.setLogWriter method, DriverManager.setLogStream (deprecated) method, SyncFactory.setJNDIContext method, SyncFactory.setLogger method, Connection.setNetworktimeout method, or the Connection.abort method.
TimeA thin wrapper around the java.util.Date class that allows the JDBC API to identify this as an SQL TIME value.
TimestampA thin wrapper around java.util.Date that allows the JDBC API to identify this as an SQL TIMESTAMP value.
TypesThe class that defines the constants that are used to identify generic SQL types, called JDBC types.
 

Enum Summary
ClientInfoStatusEnumeration for status of the reason that a property could not be set via a call to Connection.setClientInfo
JDBCTypesDefines the constants that are used to identify generic SQL types, called JDBC types.
PseudoColumnUsageEnumeration for pseudo/hidden column usage.
RowIdLifetimeEnumeration for RowId life-time values.
 

Exception Summary
BatchUpdateExceptionThe subclass of SQLException thrown when an error occurs during a batch update operation.
DataTruncationAn 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.
SQLClientInfoExceptionThe subclass of SQLException is thrown when one or more client info properties could not be set on a Connection.
SQLDataExceptionThe subclass of SQLException thrown when the SQLState class value is '22', or under vendor-specified conditions.
SQLExceptionAn exception that provides information on a database access error or other errors.
SQLFeatureNotSupportedExceptionThe subclass of SQLException thrown when the SQLState class value is '0A' ( the value is 'zero' A).
SQLIntegrityConstraintViolationExceptionThe subclass of SQLException thrown when the SQLState class value is '23', or under vendor-specified conditions.
SQLInvalidAuthorizationSpecExceptionThe subclass of SQLException thrown when the SQLState class value is '28', or under vendor-specified conditions.
SQLNonTransientConnectionExceptionThe subclass of SQLException thrown for the SQLState class value '08', or under vendor-specified conditions.
SQLNonTransientExceptionThe subclass of SQLException thrown when an instance where a retry of the same operation would fail unless the cause of the SQLException is corrected.
SQLRecoverableExceptionThe 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.
SQLSyntaxErrorExceptionThe subclass of SQLException thrown when the SQLState class value is '42', or under vendor-specified conditions.
SQLTimeoutExceptionThe subclass of SQLException thrown when the timeout specified by Statement has expired.
SQLTransactionRollbackExceptionThe subclass of SQLException thrown when the SQLState class value is '40', or under vendor-specified conditions.
SQLTransientConnectionExceptionThe subclass of SQLException for the SQLState class value '08', or under vendor-specified conditions.
SQLTransientExceptionThe 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.
SQLWarningAn exception that provides information on database access warnings.
 

Package java.sql Description

Provides the API for accessing and processing data stored in a data source (usually a relational database) using the JavaTM programming language. This API includes a framework whereby different drivers can be installed dynamically to access different data sources. Although the JDBCTM API is mainly geared to passing SQL statements to a database, it provides for reading and writing data from any data source with a tabular format. The reader/writer facility, available through the javax.sql.RowSet group of interfaces, can be customized to use and update data from a spread sheet, flat file, or any other tabular data source.

What the JDBCTM 4.1 API Includes

The JDBCTM 4.1 API includes both the java.sql package, referred to as the JDBC core API, and the javax.sql package, referred to as the JDBC Optional Package API. This complete JDBC API is included in the JavaTM Standard Edition (Java SETM), version 7. The javax.sql package extends the functionality of the JDBC API from a client-side API to a server-side API, and it is an essential part of the JavaTM Enterprise Edition (Java EETM) technology.

Versions

The JDBC 4.1 API incorporates all of the previous JDBC API versions:

Classes, interfaces, methods, fields, constructors, and exceptions have the following "since" tags that indicate when they were introduced into the Java platform. When these "since" tags are used in JavadocTM comments for the JDBC API, they indicate the following:

NOTE: Many of the new features are optional; consequently, there is some variation in drivers and the features they support. Always check your driver's documentation to see whether it supports a feature before you try to use it.

NOTE: The class SQLPermission was added in the JavaTM 2 SDK, Standard Edition, version 1.3 release. This class is used to prevent unauthorized access to the logging stream associated with the DriverManager, which may contain information such as table names, column data, and so on.

What the java.sql Package Contains

The java.sql package contains API for the following:

java.sql and javax.sql Features Introduced in the JDBC 4.1 API

java.sql and javax.sql Features Introduced in the JDBC 4.0 API

java.sql and javax.sql Features Introduced in the JDBC 3.0 API

java.sql Features Introduced in the JDBC 2.1 Core API

javax.sql Features Introduced in the JDBC 2.0 Optional Package API

Custom Mapping of UDTs

A user-defined type (UDT) defined in SQL can be mapped to a class in the Java programming language. An SQL structured type or an SQL DISTINCT type are the UDTs that may be custom mapped. The following three steps set up a custom mapping:
  1. Defining the SQL structured type or DISTINCT type in SQL
  2. Defining the class in the Java programming language to which the SQL UDT will be mapped. This class must implement the SQLData interface.
  3. Making an entry in a Connection object's type map that contains two things:

When these are in place for a UDT, calling the methods ResultSet.getObject or CallableStatement.getObject on that UDT will automatically retrieve the custom mapping for it. Also, the PreparedStatement.setObject method will automatically map the object back to its SQL type to store it in the data source.

Package Specification

Related Documentation

Since:
1.1



Java is a trademark or registered trademark of Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A All Rights Reserved.