Ready to get started?

Download a free trial of the Driver to get started:

 Download Now

Learn more: Icon JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with

Create a Data Access Object for Data using JDBI

A brief overview of creating a SQL Object API for 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 integrates connectivity to live data in Java applications. By pairing these technologies, you gain simple, programmatic access to data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write data.

Create a DAO for the Accounts 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 MyAccountsDAO { //insert new data into @SqlUpdate("INSERT INTO Accounts (Industry, NumberOfEmployees) values (:industry, :numberOfEmployees)") void insert(@Bind("industry") String industry, @Bind("numberOfEmployees") String numberOfEmployees); //request specific data from (String type is used for simplicity) @SqlQuery("SELECT NumberOfEmployees FROM Accounts WHERE Industry = :industry") String findNumberOfEmployeesByIndustry(@Bind("industry") String industry); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to

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

You must use OAuth to authenticate with Outreach. Set the InitiateOAuth connection property to "GETANDREFRESH". For more information, refer to the OAuth section in the Help documentation.

Built-in Connection String Designer

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

java -jar cdata.jdbc.outreach.jar

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

A connection string for will typically look like the following:


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:outreach:InitiateOAuth=GETANDREFRESH"); MyAccountsDAO dao =; //do stuff with the DAO dao.close();

Read Data

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

//disply the result of our 'find' method String numberOfEmployees = dao.findNumberOfEmployeesByIndustry("Textiles"); System.out.println(numberOfEmployees);

Write Data

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

//add a new entry to the Accounts entity dao.insert(newIndustry, newNumberOfEmployees);

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