Ready to get started?

Download a free trial of the Access Driver to get started:

 Download Now

Learn more:

Access Icon Access JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft Access databases.

Create a Data Access Object for Access Data using JDBI



A brief overview of creating a SQL Object API for Access data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Access integrates connectivity to live Access data in Java applications. By pairing these technologies, you gain simple, programmatic access to Access data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Access data.

Create a DAO for the Access Orders Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyOrdersDAO { //insert new data into Access @SqlUpdate("INSERT INTO Orders (ShipCity, Freight) values (:shipCity, :freight)") void insert(@Bind("shipCity") String shipCity, @Bind("freight") String freight); //request specific data from Access (String type is used for simplicity) @SqlQuery("SELECT Freight FROM Orders WHERE ShipCity = :shipCity") String findFreightByShipCity(@Bind("shipCity") String shipCity); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Access

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Access.

To connect, set the DataSource property to the path to the Access database.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Access JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.access.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Access will typically look like the following:

jdbc:access:DataSource=C:/MyDB.accdb;

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:access:DataSource=C:/MyDB.accdb;"); MyOrdersDAO dao = dbi.open(MyOrdersDAO.class); //do stuff with the DAO dao.close();

Read Access Data

With the connection open to Access, simply call the previously defined method to retrieve data from the Orders entity in Access.

//disply the result of our 'find' method String freight = dao.findFreightByShipCity("New York"); System.out.println(freight);

Write Access Data

It is also simple to write data to Access, using the previously defined method.

//add a new entry to the Orders entity dao.insert(newShipCity, newFreight);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Access by integrating with the CData JDBC Driver for Access. Download a free trial and work with live Access data in custom Java applications today.