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

Create a DAO for the Customer.io Customers 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 MyCustomersDAO {
  //request specific data from Customer.io (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Customers WHERE  = :")
  String findBy(@Bind("") String );

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

Open a Connection to Customer.io

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

Using API Key Authentication

To obtain your Customer.io App API Key, navigate to the Customer.io UI under Data & Integrations > Integrations > Customer.io API and generate your API key.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Customer.io App API Key.

Example Connection String

Profile=C:\profiles\CustomerIO.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Customer.io Data

With the connection open to Customer.io, simply call the previously defined method to retrieve data from the Customers entity in Customer.io.

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

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