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

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

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

Open a Connection to Instantly

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

Using API Key Authentication

Instantly uses API keys to authenticate requests. You can find or create your API key in the Instantly workspace settings under API & Webhooks.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Instantly API key (Bearer token for API v2).

Example connection string

Profile=C:\profiles\Instantly.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 Instantly 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 Instantly will typically look like the following:

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

//do stuff with the DAO

dao.close();

Read Instantly Data

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

//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 Instantly by integrating with the CData JDBC Driver for Instantly. Download a free trial and work with live Instantly data in custom Java applications today.