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

Create a DAO for the Pipeline CRM AccountNotifications 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 MyAccountNotificationsDAO {
  //request specific data from Pipeline CRM (String type is used for simplicity)
  @SqlQuery("SELECT AccountId FROM AccountNotifications WHERE Seen = :seen")
  String findAccountIdBySeen(@Bind("seen") String seen);

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

Open a Connection to Pipeline CRM

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

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

Pipeline CRM API Profile Settings

Retrieve your API Key via Account Settings > Pipeline API > Enable API Access > New API Key, and generate an APP Key at https://app.pipelinecrm.com/admin/modern/api by creating a new Integration.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Pipeline CRM Data

With the connection open to Pipeline CRM, simply call the previously defined method to retrieve data from the AccountNotifications entity in Pipeline CRM.

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

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