Java Database Connectivity

JDBC

Developer(s)	Oracle Corporation
Stable release	JDBC 4.3 / September 21, 2017 (2017-09-21)
Operating system	Cross-platform
Type	Data access API
Website	JDBC API Guide

Java Database Connectivity (JDBC) is an application programming interface (API) for the Java programming language which defines how a client may access a database. It is a Java-based data access technology used for Java database connectivity. It is part of the Java Standard Edition platform, from Oracle Corporation. It provides methods to query and update data in a database, and is oriented toward relational databases. A JDBC-to-ODBC bridge enables connections to any ODBC-accessible data source in the Java virtual machine (JVM) host environment.

History and implementation

Sun Microsystems released JDBC as part of Java Development Kit (JDK) 1.1 on February 19, 1997. ^[1] Since then it has been part of the Java Platform, Standard Edition (Java SE).

The JDBC classes are contained in the Java package java.sql and javax.sql .

Starting with version 3.1, JDBC has been developed under the Java Community Process. JSR 54 specifies JDBC 3.0 (included in J2SE 1.4), JSR 114 specifies the JDBC Rowset additions, and JSR 221 is the specification of JDBC 4.0 (included in Java SE 6). ^[2]

JDBC 4.1, is specified by a maintenance release 1 of JSR 221 ^[3] and is included in Java SE 7. ^[4]

JDBC 4.2, is specified by a maintenance release 2 of JSR 221 ^[5] and is included in Java SE 8. ^[6]

The latest version, JDBC 4.3, is specified by a maintenance release 3 of JSR 221 ^[7] and is included in Java SE 9. ^[8]

JDBC versions

JDBC version	Java version	Release Type	Release date
1.1	JDK 1.1	Main	1997-02-19. [1]
3.0	J2SE 1.4	Main	2002-05-09
4.0	Java SE 6	Main	2006-12-11
4.1	Java SE 7	Maintenance	2011-10-13
4.2	Java SE 8	Maintenance	2014-03-04
4.3	Java SE 9	Maintenance	2017-09-21

Functionality

Host database types which Java can convert to with a function

Oracle Datatype	setXXX() Methods
CHAR	setString()
VARCHAR2	setString()
NUMBER	setBigDecimal()
	setBoolean()
	setByte()
	setShort()
	setInt()
	setLong()
	setFloat()
	setDouble()
INTEGER	setInt()
FLOAT	setDouble()
CLOB	setClob()
BLOB	setBlob()
RAW	setBytes()
LONGRAW	setBytes()
DATE	setDate()
	setTime()
	setTimestamp()

Since JDBC ('Java Database Connectivity') is mostly a collection of interface definitions and specifications, it allows multiple implementations of these interfaces to exist and be used by the same application at runtime. The API provides a mechanism for dynamically loading the correct Java packages and registering them with the JDBC Driver Manager (DriverManager). DriverManager is used as a Connection factory for creating JDBC connections.

JDBC connections support creating and executing statements. JDBC connections support update statements such as SQL's CREATE, INSERT, UPDATE and DELETE, or query statements such as SELECT. Additionally, stored procedures may be invoked through a JDBC connection. JDBC represents statements using one of the following classes:

• Statement – the Statement is sent to the database server each and every time. In other words, the Statement methods are executed using SQL statements to obtain a ResultSet object containing the data. ^[9]
• PreparedStatement –PreparedStatement is a subinterface of the Statement interface. ^[9] The statement is cached and then the execution path is pre-determined on the database server, allowing it to be executed multiple times in an efficient manner. ^[9] PreparedStatement is used to execute pre-compiled SQL statements. ^[9] Running pre-compiled statements increases statement execution efficiency and performance. The PreparedStatement is often used for dynamic statement where some input parameters must be passed into the target database. ^[10] The

PreparedStatement allows the dynamic query to vary depending on the query parameter. ^[11]

• CallableStatement –CallableStatement is a subinterface of the Statement interface. ^[11] It is used for executing stored procedures on the database. ^{[11] [12]} Both input and output parameters must be passed into the database for stored procedures. ^[13]

Update statements such as INSERT, UPDATE and DELETE return an update count indicating the number of rows affected in the database as an integer. ^[13] These statements do not return any other information.

Query statements return a JDBC row result set. The row result set is used to walk over the result set. Individual columns in a row are retrieved either by name or by column number. There may be any number of rows in the result set. The row result set has metadata that describes the names of the columns and their types.

There is an extension to the basic JDBC API in the javax.sql .

JDBC connections are often managed via a connection pool rather than obtained directly from the driver. ^[14]

Examples

When a Java application needs a database connection, one of the DriverManager.getConnection() methods is used to create a JDBC Connection. The URL used is dependent upon the particular database and JDBC driver. It will always begin with the "jdbc:" protocol, but the rest is up to the particular vendor.

Connectionconn=DriverManager.getConnection("jdbc:somejdbcvendor:other data needed by some jdbc vendor","myLogin","myPassword");try{/* you use the connection here */}finally{//It's important to close the connection when you are done with ittry{conn.close();}catch(Throwablee){/* Propagate the original exception                                instead of this one that you want just logged */logger.warn("Could not close JDBC Connection",e);}}

Starting from Java SE 7 you can use Java's try-with-resources statement to simplify the above code:

try(Connectionconn=DriverManager.getConnection("jdbc:somejdbcvendor:other data needed by some jdbc vendor","myLogin","myPassword")){/* you use the connection here */}// the VM will take care of closing the connection

Once a connection is established, a Statement can be created.

try(Statementstmt=conn.createStatement()){stmt.executeUpdate("INSERT INTO MyTable(name) VALUES ('my name')");}

Note that Connections, Statements, and ResultSets often tie up operating system resources such as sockets or file descriptors. In the case of Connections to remote database servers, further resources are tied up on the server, e.g. cursors for currently open ResultSets. It is vital to close() any JDBC object as soon as it has played its part; garbage collection should not be relied upon. The above try-with-resources construct is a code pattern that obviates this.

Data is retrieved from the database using a database query mechanism. The example below shows creating a statement and executing a query.

try(Statementstmt=conn.createStatement();ResultSetrs=stmt.executeQuery("SELECT * FROM MyTable")){while(rs.next()){intnumColumns=rs.getMetaData().getColumnCount();for(inti=1;i<=numColumns;i++){// Column numbers start at 1.// Also, there are many methods on the result set to return//  the column as a particular type. Refer to the Sun documentation//  for the list of valid conversions.System.out.println("COLUMN "+i+" = "+rs.getObject(i));}}}

The following code is an example of a PreparedStatement query which uses conn and class from the first example:

try(PreparedStatementps=conn.prepareStatement("SELECT i.*, j.* FROM Omega i, Zappa j WHERE i.name = ? AND j.num = ?")){// In the SQL statement being prepared, each question mark is a placeholder// that must be replaced with a value you provide through a "set" method invocation.// The following two method calls replace the two placeholders; the first is// replaced by a string value, and the second by an integer value.ps.setString(1,"Poor Yorick");ps.setInt(2,8008);// The ResultSet, rs, conveys the result of executing the SQL statement.// Each time you call rs.next(), an internal row pointer, or cursor,// is advanced to the next row of the result.  The cursor initially is// positioned before the first row.try(ResultSetrs=ps.executeQuery()){while(rs.next()){intnumColumns=rs.getMetaData().getColumnCount();for(inti=1;i<=numColumns;i++){// Column numbers start at 1.// Also, there are many methods on the result set to return// the column as a particular type. Refer to the Sun documentation// for the list of valid conversions.System.out.println("COLUMN "+i+" = "+rs.getObject(i));}// for}// while}// try}// try

If a database operation fails, JDBC raises an SQLException . There is typically very little one can do to recover from such an error, apart from logging it with as much detail as possible. It is recommended that the SQLException be translated into an application domain exception (an unchecked one) that eventually results in a transaction rollback and a notification to the user.

The following code is an example of a database transaction:

booleanautoCommitDefault=conn.getAutoCommit();try{conn.setAutoCommit(false);/* You execute statements against conn here transactionally */conn.commit();}catch(Throwablee){try{conn.rollback();}catch(Throwablee){logger.warn("Could not rollback transaction",e);}throwe;}finally{try{conn.setAutoCommit(autoCommitDefault);}catch(Throwablee){logger.warn("Could not restore AutoCommit setting",e);}}

For an example of a CallableStatement (to call stored procedures in the database), see the JDBC API Guide documentation.

importjava.sql.Connection;importjava.sql.DriverManager;importjava.sql.Statement;publicclassMydb1{staticStringURL="jdbc:mysql://localhost/mydb";publicstaticvoidmain(String[]args){try{Class.forName("com.mysql.jdbc.Driver");Connectionconn=DriverManager.getConnection(URL,"root","root");Statementstmt=conn.createStatement();Stringsql="INSERT INTO emp1 VALUES ('pctb5361', 'kiril', 'john', 968666668)";stmt.executeUpdate(sql);System.out.println("Inserted records into the table...");}catch(Exceptione){e.printStackTrace();}}}

JDBC drivers

Main article: JDBC driver

JDBC drivers are client-side adapters (installed on the client machine, not on the server) that convert requests from Java programs to a protocol that the DBMS can understand.

Types

Commercial and free drivers provide connectivity to most relational-database servers. These drivers fall into one of the following types:

• Type 1 that calls native code of the locally available ODBC driver. (Note: In JDBC 4.2, JDBC-ODBC bridge has been removed ^[15] )
• Type 2 that calls database vendor native library on a client side. This code then talks to database over the network.
• Type 3, the pure-java driver that talks with the server-side middleware that then talks to the database.
• Type 4, the pure-java driver that uses database native protocol.

Note also a type called an internal JDBC driver - a driver embedded with JRE in Java-enabled SQL databases. It is used for Java stored procedures. This does not fit into the classification scheme above, although it would likely resemble either a type 2 or type 4 driver (depending on whether the database itself is implemented in Java or not). An example of this is the KPRB (Kernel Program Bundled) driver ^[16] supplied with Oracle RDBMS. "jdbc:default:connection" offers a relatively standard way of making such a connection (at least the Oracle database and Apache Derby support it). However, in the case of an internal JDBC driver, the JDBC client actually runs as part of the database being accessed, and so can access data directly rather than through network protocols.

Sources

• Oracle provides a list of some JDBC drivers and vendors
• Simba Technologies ships an SDK for building custom JDBC Drivers for any custom/proprietary relational data source
• CData Software ships type 4 JDBC Drivers for various applications, databases, and Web APIs. ^[17]
• RSSBus Type 4 JDBC Drivers for applications, databases, and web services ^[18]
• DataDirect Technologies provides a comprehensive suite of fast Type 4 JDBC drivers for all major database they advertise as Type 5 ^[19]
• IDS Software provides a Type 3 JDBC driver for concurrent access to all major databases. Supported features include resultset caching, SSL encryption, custom data source, dbShield
• JDBaccess is a Java persistence library for MySQL and Oracle which defines major database access operations in an easy usable API above JDBC
• JNetDirect provides a suite of fully Sun J2EE certified high-performance JDBC drivers.
• JDBCR4 is a service program written by Scott Klement to allow access to JDBC from RPG on the IBM i. ^[20]
• HSQLDB is a RDBMS with a JDBC driver and is available under a BSD license.
• SchemaCrawler ^[21] is an open source API that leverages JDBC, and makes database metadata available as plain old Java objects (POJOs)

See also

• GNU Data Access (GDA)
• JDBCFacade
• Open Database Connectivity (ODBC)
• Object–relational mapping (ORM)

Citations

1. "Sun Ships JDK 1.1 -- Javabeans Included". www.sun.com. Sun Microsystems. 1997-02-19. Archived from the original on 2008-02-10. Retrieved 2010-02-15. February 19, 1997 - The JDK 1.1 [...] is now available [...]. This release of the JDK includes: [...] Robust new features including JDBC for database connectivity
2. JDBC API Specification Version: 4.0.
3. "The Java Community Process(SM) Program - communityprocess - mrel". jcp.org. Retrieved 22 March 2018.
4. "JDBC 4.1". docs.oracle.com. Retrieved 22 March 2018.
5. "The Java Community Process(SM) Program - communityprocess - mrel". jcp.org. Retrieved 22 March 2018.
6. "JDBC 4.2". docs.oracle.com. Retrieved 22 March 2018.
7. "The Java Community Process(SM) Program - communityprocess - mrel". jcp.org. Retrieved 22 March 2018.
8. "java.sql (Java SE 9 & JDK 9)". docs.oracle.com. Retrieved 22 March 2018.
9. Bai 2022, p. 74.
10. Bai 2022, pp. 122–124, §4.2.3.5 More About the Execution Methods.
11. Bai 2022, pp. 72–74, §3.2 JDBC Components and Architecture.
12. Horstmann 2022, §5.5.3 SQL Escapes.
13. Bai 2022, pp. 122–124, §4.2.3.5 JDBC Components and Architecture.
14. Bai 2022, p. 83, §3.5.1 JDBC DataSource.
15. "Java JDBC API". docs.oracle.com. Retrieved 22 March 2018.
16. Greenwald, Rick; Stackowiak, Robert; Stern, Jonathan (1999). Oracle Essentials: Oracle Database 10g. Essentials Series (3 ed.). Sebastopol, California: O'Reilly Media, Inc. (published 2004). p. 318. ISBN   9780596005856 . Retrieved 2016-11-03. The in-database JDBC driver (JDBC KPRB)[:] Java code uses the JDBC KPRB (Kernel Program Bundled) version to access SQL on the same server.
17. "JDBC Drivers - CData Software". CData Software. Retrieved 22 March 2018.
18. "JDBC Drivers - CData Software". CData Software. Retrieved 22 March 2018.
19. "New Type 5 JDBC Driver — DataDirect Connect".
20. "Access External Databases from RPG with JDBCR4 Meat of the Matter". 28 June 2012. Retrieved 12 April 2016.
21. Sualeh Fatehi. "SchemaCrawler". GitHub.

References

• Bai, Ying (2022). SQL Server Database Programming with Java. Cham: Springer International Publishing. doi:10.1007/978-3-031-06553-8. ISBN   978-3-030-92686-1.
• Horstmann, Cay (April 15, 2022). Core Java. Oracle Press Java. ISBN   0-13-787107-4.

External links

• JDBC API Guide
• java.sql API Javadoc documentation
• javax.sql API Javadoc documentation
• O/R Broker Scala JDBC framework
• SqlTool Open source, command-line, generic JDBC client utility. Works with any JDBC-supporting database.
• JDBC URL Strings and related information of All Databases.