Creating JDBC Application
Creating JDBC Application
All the steps mentioned in this template example, would be explained in subsequent chapters of
this tutorial.
1. Import the packages . Requires that you include the packages containing the JDBC
classes needed for database programming. Most often, using import java.sql.* will
suffice.
2. Register the JDBC driver . Requires that you initialize a driver so you can open a
communications channel with the database.
3. Open a connection . Requires using the DriverManager.getConnection() method to
create a Connection object, which represents a physical connection with the database.
4. Execute a query . Requires using an object of type Statement for building and
submitting an SQL statement to the database.
5. Extract data from result set . Requires that you use the appropriate ResultSet.getXXX()
method to retrieve the data from the result set.
6. Clean up the environment . Requires explicitly closing all database resources versus
relying on the JVM's garbage collection.
Sample Code:
This sample example can serve as a template when you need to create your own JDBC
application in the future.
This sample code has been written based on the environment and database setup done in
previous chapter.
Copy and past following example in FirstExample.java, compile and run as follows:
// Database credentials
static final String USER = "username";
static final String PASS = "password";
//Display values
System.out.print("ID: " + id);
System.out.print(", Age: " + age);
System.out.print(", First: " + first);
System.out.println(", Last: " + last);
}
//STEP 6: Clean-up environment
rs.close();
stmt.close();
conn.close();
}catch(SQLException se){
//Handle errors for JDBC
se.printStackTrace();
}catch(Exception e){
//Handle errors for Class.forName
e.printStackTrace();
}finally{
//finally block used to close resources
try{
if(stmt!=null)
stmt.close();
}catch(SQLException se2){
}// nothing we can do
try{
if(conn!=null)
conn.close();
}catch(SQLException se){
se.printStackTrace();
}//end finally try
}//end try
System.out.println("Goodbye!");
}//end main
}//end FirstExample
C:\>javac FirstExample.java
C:\>
For example, using JDBC drivers enable you to open database connections and to interact with it
by sending SQL or database commands then receiving results with Java.
The Java.sql package that ships with JDK contains various classes with their behaviours defined
and their actual implementaions are done in third-party drivers. Third party vendors implements
the java.sql.Driver interface in their database driver.
In a Type 1 driver, a JDBC bridge is used to access ODBC drivers installed on each client
machine. Using ODBC requires configuring on your system a Data Source Name (DSN) that
represents the target database.
When Java first came out, this was a useful driver because most databases only supported ODBC
access but now this type of driver is recommended only for experimental use or when no other
alternative is available.
The JDBC-ODBC bridge that comes with JDK 1.2 is a good example of this kind of driver.
In a Type 2 driver, JDBC API calls are converted into native C/C++ API calls which are unique
to the database. These drivers typically provided by the database vendors and used in the same
manner as the JDBC-ODBC Bridge, the vendor-specific driver must be installed on each client
machine.
If we change the Database we have to change the native API as it is specific to a database and
they are mostly obsolete now but you may realize some speed increase with a Type 2 driver,
because it eliminates ODBC's overhead.
The Oracle Call Interface (OCI) driver is an example of a Type 2 driver.
In a Type 3 driver, a three-tier approach is used to accessing databases. The JDBC clients use
standard network sockets to communicate with an middleware application server. The socket
information is then translated by the middleware application server into the call format required
by the DBMS, and forwarded to the database server.
This kind of driver is extremely flexible, since it requires no code installed on the client and a
single driver can actually provide access to multiple databases.
You can think of the application server as a JDBC "proxy," meaning that it makes calls for the
client application. As a result, you need some knowledge of the application server's configuration
in order to effectively use this driver type.
Your application server might use a Type 1, 2, or 4 driver to communicate with the database,
understanding the nuances will prove helpful.
In a Type 4 driver, a pure Java-based driver that communicates directly with vendor's database
through socket connection. This is the highest performance driver available for the database and
is usually provided by the vendor itself.
This kind of driver is extremely flexible, you don't need to install special software on the client
or server. Further, these drivers can be downloaded dynamically.
MySQL's Connector/J driver is a Type 4 driver. Because of the proprietary nature of their
network protocols, database vendors usually supply type 4 drivers.
If you are accessing one type of database, such as Oracle, Sybase, or IBM, the preferred driver
type is 4.
If your Java application is accessing multiple types of databases at the same time, type 3 is the
preferred driver.
Type 2 drivers are useful in situations where a type 3 or type 4 driver is not available yet for your
database.
The type 1 driver is not considered a deployment-level driver and is typically used for
development and testing purposes only.
After you've installed the appropriate driver, it's time to establish a database connection using
JDBC.
The programming involved to establish a JDBC connection is fairly simple. Here are these
simple four steps:
1. Import JDBC Packages: Add import statements to your Java program to import
required classes in your Java code.
2. Register JDBC Driver: This step causes the JVM to load the desired driver
implementation into memory so it can fulfill your JDBC requests.
3. Database URL Formulation: This is to create a properly formatted address that points
to the database to which you wish to connect.
To use the standard JDBC package, which allows you to select, insert, update, and delete data in
SQL tables, add the following imports to your source code:
You must register the your driver in your program before you use it. Registering the driver is the
process by which the Oracle driver's class file is loaded into memory so it can be utilized as an
implementation of the JDBC interfaces.
You need to do this registration only once in your program. You can register a driver in one of
two ways.
The most common approach to register a driver is to use Java's Class.forName() method to
dynamically load the driver's class file into memory, which automatically registers it. This
method is preferable because it allows you to make the driver registration configurable and
portable.
try {
Class.forName("oracle.jdbc.driver.OracleDriver");
}
catch(ClassNotFoundException ex) {
System.out.println("Error: unable to load driver class!");
System.exit(1);
}
You can use getInstance() method to work around noncompliant JVMs, but then you'll have to
code for two extra Exceptions as follows:
try {
Class.forName("oracle.jdbc.driver.OracleDriver").newInstance();
}
catch(ClassNotFoundException ex) {
System.out.println("Error: unable to load driver class!");
System.exit(1);
catch(IllegalAccessException ex) {
System.out.println("Error: access problem while loading!");
System.exit(2);
catch(InstantiationException ex) {
System.out.println("Error: unable to instantiate driver!");
System.exit(3);
}
The second approach you can use to register a driver is to use the static
DriverManager.registerDriver() method.
You should use the registerDriver() method if you are using a non-JDK compliant JVM, such as
the one provided by Microsoft.
try {
Driver myDriver = new oracle.jdbc.driver.OracleDriver();
DriverManager.registerDriver( myDriver );
}
catch(ClassNotFoundException ex) {
System.out.println("Error: unable to load driver class!");
System.exit(1);
}
After you've loaded the driver, you can establish a connection using the
DriverManager.getConnection() method. For easy reference, let me list the three overloaded
DriverManager.getConnection() methods:
1. getConnection(String url)
Here each form requires a database URL. A database URL is an address that points to your
database.
Formulating a database URL is where most of the problems associated with establishing a
connection occur.
Following table lists down popular JDBC driver names and database URL.
jdbc:oracle:thin:@hostname:port
ORACLE oracle.jdbc.driver.OracleDriver
Number:databaseName
jdbc:sybase:Tds:hostname: port
Sybase com.sybase.jdbc.SybDriver
Number/databaseName
All the highlighted part in URL format is static and you need to change only remaining part as
per your database setup.
Assuming you are using Oracle's thin driver, you'll specify a host:port:databaseName value for
the database portion of the URL.
If you have a host at TCP/IP address 192.0.0.1 with a host name of amrood, and your Oracle
listener is configured to listen on port 1521, and your database name is EMP, then complete
database URL would then be:
jdbc:oracle:thin:@amrood:1521:EMP
Now you have to call getConnection() method with appropriate username and password to get a
Connection object as follows:
DriverManager.getConnection(String url);
However, in this case, the database URL includes the username and password and has the
following general form:
jdbc:oracle:driver:username/password@database
A Properties object holds a set of keyword-value pairs. It's used to pass driver properties to the
driver during a call to the getConnection() method.
To make the same connection made by the previous examples, use the following code:
import java.util.*;
At the end of your JDBC program, it is required explicitly close all the connections to the
database to end each database session. However, if you forget, Java's garbage collector will close
the connection when it cleans up stale objects.
Relying on garbage collection, especially in database programming, is very poor programming
practice. You should make a habit of always closing the connection with the close() method
associated with connection object.
To ensure that a connection is closed, you could provide a finally block in your code. A finally
block always executes, regardless if an exception occurs or not.
To close above opened connection you should call close() method as follows:
conn.close();
Explicitly closing a connection conserves DBMS resources, which will make your database
administrator happy.
For a better understanding, I would suggest to study our JDBC - Sample Code.
Once a connection is obtained we can interact with the database. The JDBC Statement,
CallableStatement, and PreparedStatement interfaces define the methods and properties that
enable you to send SQL or PL/SQL commands and receive data from your database.
They also define methods that help bridge data type differences between Java and SQL data
types used in a database.
Following table provides a summary of each interface's purpose to understand how do you
decide which interface to use?
Use for general-purpose access to your database. Useful when you are
Statement using static SQL statements at runtime. The Statement interface cannot
accept parameters.
Use when you plan to use the SQL statements many times. The
PreparedStatement
PreparedStatement interface accepts input parameters at runtime.
Before you can use a Statement object to execute a SQL statement, you need to create one using
the Connection object's createStatement( ) method, as in the following example:
Once you've created a Statement object, you can then use it to execute a SQL statement with one
of its three execute methods.
1. boolean execute(String SQL) : Returns a boolean value of true if a ResultSet object can
be retrieved; otherwise, it returns false. Use this method to execute SQL DDL statements
or when you need to use truly dynamic SQL.
2. int executeUpdate(String SQL) : Returns the numbers of rows affected by the execution
of the SQL statement. Use this method to execute SQL statements for which you expect
to get a number of rows affected - for example, an INSERT, UPDATE, or DELETE
statement.
Just as you close a Connection object to save database resources, for the same reason you should
also close the Statement object.
A simple call to the close() method will do the job. If you close the Connection object first it will
close the Statement object as well. However, you should always explicitly close the Statement
object to ensure proper cleanup.
All parameters in JDBC are represented by the ? symbol, which is known as the parameter
marker. You must supply values for every parameter before executing the SQL statement.
The setXXX() methods bind values to the parameters, where XXX represents the Java data type
of the value you wish to bind to the input parameter. If you forget to supply the values, you will
receive an SQLException.
Each parameter marker is referred to by its ordinal position. The first marker represents position
1, the next position 2, and so forth. This method differs from that of Java array indices, which
start at 0.
All of the Statement object's methods for interacting with the database (a) execute(), (b)
executeQuery(), and (c) executeUpdate() also work with the PreparedStatement object. However,
the methods are modified to use SQL statements that can take input the parameters.
Just as you close a Statement object, for the same reason you should also close the
PreparedStatement object.
A simple call to the close() method will do the job. If you close the Connection object first it will
close the PreparedStatement object as well. However, you should always explicitly close the
PreparedStatement object to ensure proper cleanup.
Just as a Connection object creates the Statement and PreparedStatement objects, it also creates
the CallableStatement object which would be used to execute a call to a database stored
procedure.
NOTE: Above stored procedure has been written for Oracle, but we are working with MySQL
database so let us write same stored procedure for MySQL as follows to create it in EMP
database:
DELIMITER $$
DELIMITER ;
Three types of parameters exist: IN, OUT, and INOUT. The PreparedStatement object only uses
the IN parameter. The CallableStatement object can use all three.
Parameter Description
A parameter that provides both input and output values. You bind
INOUT variables with the setXXX() methods and retrieve values with the
getXXX() methods.
The following code snippet shows how to employ the Connection.prepareCall() method to
instantiate a CallableStatement object based on the preceding stored procedure:
The String variable SQL represents the stored procedure, with parameter placeholders.
Using CallableStatement objects is much like using PreparedStatement objects. You must bind
values to all parameters before executing the statement, or you will receive an SQLException.
If you have IN parameters, just follow the same rules and techniques that apply to a
PreparedStatement object; use the setXXX() method that corresponds to the Java data type you
are binding.
When you use OUT and INOUT parameters you must employ an additional CallableStatement
method, registerOutParameter(). The registerOutParameter() method binds the JDBC data type to
the data type the stored procedure is expected to return.
Once you call your stored procedure, you retrieve the value from the OUT parameter with the
appropriate getXXX() method. This method casts the retrieved value of SQL type to a Java data
type.
Just as you close other Statement object, for the same reason you should also close the
CallableStatement object.
A simple call to the close() method will do the job. If you close the Connection object first it will
close the CallableStatement object as well. However, you should always explicitly close the
CallableStatement object to ensure proper cleanup.
The SQL statements that read data from a database query return the data in a result set. The
SELECT statement is the standard way to select rows from a database and view them in a result
set. The java.sql.ResultSet interface represents the result set of a database query.
A ResultSet object maintains a cursor that points to the current row in the result set. The term
"result set" refers to the row and column data contained in a ResultSet object.
The methods of the ResultSet interface can be broken down into three categories:
1. Navigational methods: used to move the cursor around.
2. Get methods: used to view the data in the columns of the current row being pointed to
by the cursor.
3. Update methods: used to update the data in the columns of the current row. The updates
can then be updated in the underlying database as well.
The cursor is movable based on the properties of the ResultSet. These properties are designated
when the corresponding Statement that generated the ResultSet is created.
JDBC provides following connection methods to create statements with desired ResultSet:
The first argument indicate the type of a ResultSet object and the second argument is one of two
ResultSet constants for specifying whether a result set is read-only or updatable.
Type of ResultSet:
The possible RSType are given below, If you do not specify any ResultSet type, you will
automatically get one that is TYPE_FORWARD_ONLY.
Type Description
ResultSet.TYPE_FORWARD_ONLY The cursor can only move forward in the result set.
Concurrency of ResultSet:
The possible RSConcurrency are given below, If you do not specify any Concurrency type, you
will automatically get one that is CONCUR_READ_ONLY.
Concurrency Description
Our all the examples written so far can be written as follows which initializes a Statement object
to create a forward-only, read only ResultSet object:
try {
Statement stmt = conn.createStatement(
ResultSet.TYPE_FORWARD_ONLY,
ResultSet.CONCUR_READ_ONLY);
}
catch(Exception ex) {
....
}
finally {
....
}
There are several methods in the ResultSet interface that involve moving the cursor, including:
The ResultSet interface contains dozens of methods for getting the data of the current row.
There is a get method for each of the possible data types, and each get method has two versions:
For example, if the column you are interested in viewing contains an int, you need to use one of
the getInt() methods of ResultSet:
Similarly there are get methods in the ResultSet interface for each of the eight Java primitive
types, as well as common types such as java.lang.String, java.lang.Object, and java.net.URL
There are also methods for getting SQL data types java.sql.Date, java.sql.Time,
java.sql.TimeStamp, java.sql.Clob, and java.sql.Blob. Check the documentation for more
information about using these SQL data types.
The ResultSet interface contains a collection of update methods for updating the data of a result
set.
As with the get methods, there are two update methods for each data type:
For example, to update a String column of the current row of a result set, you would use one of
the following updateString() methods:
There are update methods for the eight primitive data types, as well as String, Object, URL, and
the SQL data types in the java.sql package.
Updating a row in the result set changes the columns of the current row in the ResultSet object,
but not in the underlying database. To update your changes to the row in the database, you need
to invoke one of the following methods.
S.N. Methods & Description
Transaction
If your JDBC Connection is in auto-commit mode, which it is by default, then every SQL
statement is committed to the database upon its completion.
That may be fine for simple applications, but there are three reasons why you may want to turn
off auto-commit and manage your own transactions:
1. To increase performance
2. To maintain the integrity of business processes
3. To use distributed transactions
Transactions enable you to control if, and when, changes are applied to the database. It treats a
single SQL statement or a group of SQL statements as one logical unit, and if any statement
fails, the whole transaction fails.
To enable manual- transaction support instead of the auto-commit mode that the JDBC driver
uses by default, use the Connection object's setAutoCommit() method. If you pass a boolean
false to setAutoCommit( ), you turn off auto-commit. You can pass a boolean true to turn it back
on again.
For example, if you have a Connection object named conn, code the following to turn off auto-
commit:
conn.setAutoCommit(false);
Once you are done with your changes and you want to commit the changes then call commit()
method on connection object as follows:
conn.commit( );
Otherwise, to roll back updates to the database made using the Connection named conn, use the
following code:
conn.rollback( );
The following example illustrates the use of a commit and rollback object:
try{
//Assume a valid connection object conn
conn.setAutoCommit(false);
Statement stmt = conn.createStatement();
In this case none of the abobe INSERT statement would success and everything would be rolled
back.
Using Savepoints:
The new JDBC 3.0 Savepoint interface gives you additional transactional control. Most modern
DBMS support savepoints within their environments such as Oracle's PL/SQL.
When you set a savepoint you define a logical rollback point within a transaction. If an error
occurs past a savepoint, you can use the rollback method to undo either all the changes or only
the changes made after the savepoint.
The Connection object has two new methods that help you manage savepoints:
There is one rollback ( String savepointName ) method which rolls back work to the specified
savepoint.
try{
//Assume a valid connection object conn
conn.setAutoCommit(false);
Statement stmt = conn.createStatement();
//set a Savepoint
Savepoint savepoint1 = conn.setSavepoint("Savepoint1");
String SQL = "INSERT INTO Employees " +
"VALUES (106, 20, 'Rita', 'Tez')";
stmt.executeUpdate(SQL);
//Submit a malformed SQL statement that breaks
String SQL = "INSERTED IN Employees " +
"VALUES (107, 22, 'Sita', 'Tez')";
stmt.executeUpdate(SQL);
// If there is no error, commit the changes.
conn.commit();
}catch(SQLException se){
// If there is any error.
conn.rollback(savepoint1);
}
In this case none of the abobe INSERT statement would success and everything would be rolled
back.For a better understanding, I would suggest to study Savepoints - Example Code.