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

Create a DAO for the Codat 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 Codat (String type is used for simplicity)
  @SqlQuery("SELECT CompanyId FROM Accounts WHERE Status = :status")
  String findCompanyIdByStatus(@Bind("status") String status);

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

Open a Connection to Codat

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

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

Codat API Profile Settings

Log into the Codat Portal, navigate to Accounts > Profile > API Key to obtain your API key.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Codat Data

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

//disply the result of our 'find' method
String companyId = dao.findCompanyIdByStatus("Active");
System.out.println(companyId);

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