Create a Data Access Object for Jodoo Data using JDBI

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
A brief overview of creating a SQL Object API for Jodoo 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 Jodoo integrates connectivity to live Jodoo data in Java applications. By pairing these technologies, you gain simple, programmatic access to Jodoo data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Jodoo data.

Create a DAO for the Jodoo 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 {
  //request specific data from Jodoo (String type is used for simplicity)
  @SqlQuery("SELECT EntryId FROM Accounts WHERE Priority = :priority")
  String findEntryIdByPriority(@Bind("priority") String priority);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Jodoo

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

Start by setting the Profile connection property to the location of the Jodoo Profile on disk (e.g. C:\profiles\Jodoo.apip). Next, set the ProfileSettings connection property to the connection string for Jodoo (see below).

Jodoo API Profile Settings

Obtain your API Key from the API Key page of the Jodoo Open Platform under your account settings.

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

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

jdbc:api:Profile=C:\profiles\Jodoo.apip;ProfileSettings='APIKey=your_api_key';

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:api:Profile=C:\profiles\Jodoo.apip;ProfileSettings='APIKey=your_api_key';");
MyAccountsDAO dao = dbi.open(MyAccountsDAO.class);

//do stuff with the DAO

dao.close();

Read Jodoo Data

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

//disply the result of our 'find' method
String entryId = dao.findEntryIdByPriority("High");
System.out.println(entryId);

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

Ready to get started?

Connect to live data from Jodoo with the API Driver

Connect to Jodoo