JavaTM 2 Platform
Std. Ed. v1.4.0

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
Array The mapping in the Java programming language for the SQL type ARRAY.
Blob The representation (mapping) in the JavaTM programming language of an SQL BLOB value.
CallableStatement The interface used to execute SQL stored procedures.
Clob The mapping in the JavaTM 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.
ParameterMetaData An object that can be used to get information about the types and properties of the parameters 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.
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.
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.
 

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.
 

Exception Summary
BatchUpdateException An exception thrown when an error occurs during a batch update operation.
DataTruncation An exception that reports a DataTruncation warning (on reads) or throws a DataTruncation exception (on writes) when JDBC unexpectedly truncates a data value.
SQLException An exception that provides information on a database access error or other errors.
SQLWarning An 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 3.0 API Includes

The JDBCTM 3.0 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 2 SDK, Standard Edition (J2SETM), version 1.4. 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 2 SDK, Enterprise Edition (J2EETM) technology. (Note that the J2EE platform also includes the complete JDBC API; features new in the JDBC 3.0 API are included in the J2EE version 1.3).

Versions

The JDBC 3.0 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 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

JavaTM 2 Platform
Std. Ed. v1.4.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.