Create a Data Access Object for ChartMogul Data using 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 ChartMogul integrates connectivity to live ChartMogul data in Java applications. By pairing these technologies, you gain simple, programmatic access to ChartMogul data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read ChartMogul data.

Create a DAO for the ChartMogul Account 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 MyAccountDAO {
  //request specific data from ChartMogul (String type is used for simplicity)
  @SqlQuery("SELECT Currency FROM Account WHERE WeekStartOn = :weekStartOn")
  String findCurrencyByWeekStartOn(@Bind("weekStartOn") String weekStartOn);

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

Open a Connection to ChartMogul

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

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

ChartMogul API Profile Settings

Log into your ChartMogul account, navigate to Settings > API Keys, and click Add API Key to generate a new key.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the ChartMogul 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 ChartMogul will typically look like the following:

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

//do stuff with the DAO

dao.close();

Read ChartMogul Data

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

//disply the result of our 'find' method
String currency = dao.findCurrencyByWeekStartOn("monday");
System.out.println(currency);

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