Package java.sql
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 JDBC 4.3 API Includes
The JDBC 4.3 API includes both thejava.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 Java Standard Edition (Java SE), 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 Java Enterprise Edition
(Java EE) technology.
Versions
The JDBC 4.3 API incorporates all of the previous JDBC API versions:- The JDBC 4.2 API
- The JDBC 4.1 API
- The JDBC 4.0 API
- The JDBC 3.0 API
- The JDBC 2.1 core API
- The JDBC 2.0 Optional Package API
(Note that the JDBC 2.1 core API and the JDBC 2.0 Optional Package API together are referred to as the JDBC 2.0 API.) - The JDBC 1.2 API
- The JDBC 1.0 API
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 Javadoc comments for the JDBC API, they indicate the following:
- Since 9 -- new in the JDBC 4.3 API and part of the Java SE platform, version 9
- Since 1.8 -- new in the JDBC 4.2 API and part of the Java SE platform, version 8
- Since 1.7 -- new in the JDBC 4.1 API and part of the Java SE platform, version 7
- Since 1.6 -- new in the JDBC 4.0 API and part of the Java SE platform, version 6
- Since 1.4 -- new in the JDBC 3.0 API and part of the J2SE platform, version 1.4
- Since 1.2 -- new in the JDBC 2.0 API and part of the J2SE platform, version 1.2
- Since 1.1 or no "since" tag -- in the original JDBC 1.0 API and part of the JDK, version 1.1
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.
What the java.sql
Package Contains
The java.sql
package contains API for the following:
- Making a connection with a database via the
DriverManager
facilityDriverManager
class -- makes a connection with a driverDriver
interface -- provides the API for registering and connecting drivers based on JDBC technology ("JDBC drivers"); generally used only by theDriverManager
classDriverPropertyInfo
class -- provides properties for a JDBC driver; not used by the general user
- Sending SQL statements to a database
Statement
-- used to send basic SQL statementsPreparedStatement
-- used to send prepared statements or basic SQL statements (derived fromStatement
)CallableStatement
-- used to call database stored procedures (derived fromPreparedStatement
)Connection
interface -- provides methods for creating statements and managing connections and their propertiesSavepoint
-- provides savepoints in a transaction
- Retrieving and updating the results of a query
ResultSet
interface
- Standard mappings for SQL types to classes and interfaces in the
Java programming language
Array
interface -- mapping for SQLARRAY
Blob
interface -- mapping for SQLBLOB
Clob
interface -- mapping for SQLCLOB
Date
class -- mapping for SQLDATE
NClob
interface -- mapping for SQLNCLOB
Ref
interface -- mapping for SQLREF
RowId
interface -- mapping for SQLROWID
Struct
interface -- mapping for SQLSTRUCT
SQLXML
interface -- mapping for SQLXML
Time
class -- mapping for SQLTIME
Timestamp
class -- mapping for SQLTIMESTAMP
Types
class -- provides constants for SQL types
- Custom mapping an SQL user-defined type (UDT) to a class in the
Java programming language
SQLData
interface -- specifies the mapping of a UDT to an instance of this classSQLInput
interface -- provides methods for reading UDT attributes from a streamSQLOutput
interface -- provides methods for writing UDT attributes back to a stream
- Metadata
DatabaseMetaData
interface -- provides information about the databaseResultSetMetaData
interface -- provides information about the columns of aResultSet
objectParameterMetaData
interface -- provides information about the parameters toPreparedStatement
commands
- Exceptions
SQLException
-- thrown by most methods when there is a problem accessing data and by some methods for other reasonsSQLWarning
-- thrown to indicate a warningDataTruncation
-- thrown to indicate that data may have been truncatedBatchUpdateException
-- thrown to indicate that not all commands in a batch update executed successfully
java.sql
and javax.sql
Features Introduced in the JDBC 4.3 API
- Added
Sharding
support - Enhanced
Connection
to be able to provide hints to the driver that a request, an independent unit of work, is beginning or ending - Enhanced
DatabaseMetaData
to determine if Sharding is supported - Added the method
drivers
toDriverManager
to return a Stream of the currently loaded and available JDBC drivers - Added support to
Statement
for enquoting literals and simple identifiers - Clarified the Java SE version that methods were deprecated
java.sql
and javax.sql
Features Introduced in the JDBC 4.2 API
- Added
JDBCType
enum andSQLType
interface - Support for
REF CURSORS
inCallableStatement
DatabaseMetaData
methods to return maximum Logical LOB size and if Ref Cursors are supported- Added support for large update counts
java.sql
and javax.sql
Features Introduced in the JDBC 4.1 API
- Allow
Connection
,ResultSet
andStatement
objects to be used with the try-with-resources statement - Support added to
CallableStatement
andResultSet
to specify the Java type to convert to via thegetObject
method DatabaseMetaData
methods to return PseudoColumns and if a generated key is always returned- Added support to
Connection
to specify a database schema, abort and timeout a physical connection. - Added support to close a
Statement
object when its dependent objects have been closed - Support for obtaining the parent logger for a
Driver
,DataSource
,ConnectionPoolDataSource
andXADataSource
java.sql
and javax.sql
Features Introduced in the JDBC 4.0 API
- auto java.sql.Driver discovery -- no longer need to load a
java.sql.Driver
class viaClass.forName
- National Character Set support added
- Support added for the SQL:2003 XML data type
- SQLException enhancements -- Added support for cause chaining; New SQLExceptions added for common SQLState class value codes
- Enhanced Blob/Clob functionality -- Support provided to create and free a Blob/Clob instance as well as additional methods added to improve accessibility
- Support added for accessing a SQL ROWID
- Support added to allow a JDBC application to access an instance of a JDBC resource that has been wrapped by a vendor, usually in an application server or connection pooling environment.
- Availability to be notified when a
PreparedStatement
that is associated with aPooledConnection
has been closed or the driver determines is invalid
java.sql
and javax.sql
Features Introduced in the JDBC 3.0 API
- Pooled statements -- reuse of statements associated with a pooled connection
- Savepoints -- allow a transaction to be rolled back to a designated savepoint
- Properties defined for
ConnectionPoolDataSource
-- specify how connections are to be pooled - Metadata for parameters of a
PreparedStatement
object - Ability to retrieve values from automatically generated columns
- Ability to have multiple
ResultSet
objects returned fromCallableStatement
objects open at the same time - Ability to identify parameters to
CallableStatement
objects by name as well as by index ResultSet
holdability -- ability to specify whether cursors should be held open or closed at the end of a transaction- Ability to retrieve and update the SQL structured type instance that a
Ref
object references - Ability to programmatically update
BLOB
,CLOB
,ARRAY
, andREF
values. - Addition of the
java.sql.Types.DATALINK
data type -- allows JDBC drivers access to objects stored outside a data source - Addition of metadata for retrieving SQL type hierarchies
java.sql
Features Introduced in the JDBC 2.1 Core API
- Scrollable result sets--using new methods in the
ResultSet
interface that allow the cursor to be moved to a particular row or to a position relative to its current position - Batch updates
- Programmatic updates--using
ResultSet
updater methods - New data types--interfaces mapping the SQL3 data types
- Custom mapping of user-defined types (UDTs)
- Miscellaneous features, including performance hints, the use of character
streams, full precision for
java.math.BigDecimal
values, additional security, and support for time zones in date, time, and timestamp values.
javax.sql
Features Introduced in the JDBC 2.0 Optional
Package API
- The
DataSource
interface as a means of making a connection. The Java Naming and Directory Interface (JNDI) is used for registering aDataSource
object with a naming service and also for retrieving it. - Pooled connections -- allowing connections to be used and reused
- Distributed transactions -- allowing a transaction to span diverse DBMS servers
RowSet
technology -- providing a convenient means of handling and passing data
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 SQLDISTINCT
type are the UDTs that may be custom mapped. The following three
steps set up a custom mapping:
- Defining the SQL structured type or
DISTINCT
type in SQL - Defining the class in the Java programming language to which the
SQL UDT will be mapped. This class must implement the
SQLData
interface. - Making an entry in a
Connection
object's type map that contains two things:- the fully-qualified SQL name of the UDT
- the
Class
object for the class that implements theSQLData
interface
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
- Lesson:JDBC Basics(The Java Tutorials > JDBC Database Access)
- “JDBC API Tutorial and Reference, Third Edition”
- Since:
- 1.1
-
ClassDescriptionThe mapping in the Java programming language for the SQL type
ARRAY
.The subclass ofSQLException
thrown when an error occurs during a batch update operation.The representation (mapping) in the Java programming language of an SQLBLOB
value.The interface used to execute SQL stored procedures.Enumeration for status of the reason that a property could not be set via a call toConnection.setClientInfo
The mapping in the Java programming language for the SQLCLOB
type.A connection (session) with a specific database.A builder created from aDataSource
object, used to establish a connection to the database that thedata source
object represents.Comprehensive information about the database as a whole.An exception thrown as aDataTruncation
exception (on writes) or reported as aDataTruncation
warning (on reads) when a data values is unexpectedly truncated for reasons other than its having exceededMaxFieldSize
.A thin wrapper around a millisecond value that allows JDBC to identify this as an SQLDATE
value.The interface that every driver class must implement.An interface that must be implemented when a Driver wants to be notified byDriverManager
.The basic service for managing a set of JDBC drivers.Driver properties for making a connection.Defines the constants that are used to identify generic SQL types, called JDBC types.The mapping in the Java programming language for the SQLNCLOB
type.An object that can be used to get information about the types and properties for each parameter marker in aPreparedStatement
object.An object that represents a precompiled SQL statement.Enumeration for pseudo/hidden column usage.The mapping in the Java programming language of an SQLREF
value, which is a reference to an SQL structured type value in the database.A table of data representing a database result set, which is usually generated by executing a statement that queries the database.An object that can be used to get information about the types and properties of the columns in aResultSet
object.The representation (mapping) in the Java programming language of an SQL ROWID value.Enumeration for RowId life-time values.The representation of a savepoint, which is a point within the current transaction that can be referenced from theConnection.rollback
method.Interface used to indicate that this object represents a Sharding Key.A builder created from aDataSource
orXADataSource
object, used to create aShardingKey
with sub-keys of supported data types.The subclass ofSQLException
is thrown when one or more client info properties could not be set on aConnection
.The interface used for the custom mapping of an SQL user-defined type (UDT) to a class in the Java programming language.The subclass ofSQLException
thrown when the SQLState class value is '22', or under vendor-specified conditions.An exception that provides information on a database access error or other errors.The subclass ofSQLException
thrown when the SQLState class value is '0A' ( the value is 'zero' A).An input stream that contains a stream of values representing an instance of an SQL structured type or an SQL distinct type.The subclass ofSQLException
thrown when the SQLState class value is '23', or under vendor-specified conditions.The subclass ofSQLException
thrown when the SQLState class value is '28', or under vendor-specified conditions.The subclass ofSQLException
thrown for the SQLState class value '08', or under vendor-specified conditions.The subclass ofSQLException
thrown when an instance where a retry of the same operation would fail unless the cause of theSQLException
is corrected.The output stream for writing the attributes of a user-defined type back to the database.ASQLPermission
object contains a name (also referred to as a "target name") but no actions list; there is either a named permission or there is not.The subclass ofSQLException
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.The subclass ofSQLException
thrown when the SQLState class value is '42', or under vendor-specified conditions.The subclass ofSQLException
thrown when the timeout specified byStatement.setQueryTimeout
,DriverManager.setLoginTimeout
,DataSource.setLoginTimeout
,XADataSource.setLoginTimeout
has expired.The subclass ofSQLException
thrown when the SQLState class value is '40', or under vendor-specified conditions.The subclass ofSQLException
for the SQLState class value '08', or under vendor-specified conditions.The subclass ofSQLException
is thrown in situations where a previously failed operation might be able to succeed when the operation is retried without any intervention by application-level functionality.An object that is used to identify a generic SQL type, called a JDBC type or a vendor specific data type.An exception that provides information on database access warnings.The mapping in the JavaTM programming language for the SQL XML type.The object used for executing a static SQL statement and returning the results it produces.The standard mapping in the Java programming language for an SQL structured type.A thin wrapper around thejava.util.Date
class that allows the JDBC API to identify this as an SQLTIME
value.A thin wrapper aroundjava.util.Date
that allows the JDBC API to identify this as an SQLTIMESTAMP
value.The class that defines the constants that are used to identify generic SQL types, called JDBC types.Interface for JDBC classes which provide the ability to retrieve the delegate instance when the instance in question is in fact a proxy class.