/* * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ /** * * Provides the API for accessing and processing data stored in a * data source (usually a relational database) using the * Java™ programming language. * This API includes a framework whereby different * drivers can be installed dynamically to access different data sources. * Although the JDBC™ 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 JDBC™ 4.3 API Includes

* The JDBC™ 4.3 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 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. *

* NOTE: The class SQLPermission was added in the * Java™ 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: *

Making a connection with a database via the DriverManager facility *
- DriverManager class -- makes a connection with a driver *
- SQLPermission class -- provides permission when code * running within a Security Manager, such as an applet, * attempts to set up a logging stream through the * DriverManager *
- Driver interface -- provides the API for registering * and connecting drivers based on JDBC technology ("JDBC drivers"); * generally used only by the DriverManager class *
- DriverPropertyInfo 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 statements *
- PreparedStatement -- used to send prepared statements or * basic SQL statements (derived from Statement) *
- CallableStatement -- used to call database stored * procedures (derived from PreparedStatement) *
- Connection interface -- provides methods for creating * statements and managing connections and their properties *
- Savepoint -- 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 SQL ARRAY *
- Blob interface -- mapping for SQL BLOB *
- Clob interface -- mapping for SQL CLOB *
- Date class -- mapping for SQL DATE *
- NClob interface -- mapping for SQL NCLOB *
- Ref interface -- mapping for SQL REF *
- RowId interface -- mapping for SQL ROWID *
- Struct interface -- mapping for SQL STRUCT *
- SQLXML interface -- mapping for SQL XML *
- Time class -- mapping for SQL TIME *
- Timestamp class -- mapping for SQL TIMESTAMP *
- 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 class *
- SQLInput interface -- provides methods for reading * UDT attributes from a stream *
- SQLOutput interface -- provides methods for writing * UDT attributes back to a stream *
*
Metadata *
- DatabaseMetaData interface -- provides information * about the database *
- ResultSetMetaData interface -- provides information * about the columns of a ResultSet object *
- ParameterMetaData interface -- provides information * about the parameters to PreparedStatement commands *
*
Exceptions *
- SQLException -- thrown by most methods when there * is a problem accessing data and by some methods for other reasons *
- SQLWarning -- thrown to indicate a warning *
- DataTruncation -- thrown to indicate that data may have * been truncated *
- BatchUpdateException -- 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 to DriverManager * 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 and SQLType interface
Support for REF CURSORS in CallableStatement *
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 and Statement objects to be * used with the try-with-resources statement
Support added to CallableStatement and * ResultSet to specify the Java type to convert to via the * getObject 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 and * XADataSource

`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 via Class.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 a PooledConnection 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 from CallableStatement 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, and REF 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 a DataSource 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 SQL DISTINCT * 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 the * SQLData 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

* *

JDBC 4.3 Specification *

* *

What the JDBC™ 4.3 API Includes

Versions

What the java.sql Package Contains

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

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

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