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

Create a DAO for the PabblySubscriptions CustomerInvoices 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 MyCustomerInvoicesDAO {
  //request specific data from PabblySubscriptions (String type is used for simplicity)
  @SqlQuery("SELECT Id FROM CustomerInvoices WHERE Status = :status")
  String findIdByStatus(@Bind("status") String status);

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

Open a Connection to PabblySubscriptions

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

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

PabblySubscriptions API Profile Settings

Navigate to Settings > API Settings > Regenerate API in your Pabbly Subscriptions account to obtain your API Key and Secret Key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\PabblySubscriptions.apip;ProfileSettings='User=your_api_key;Password=your_secret_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\PabblySubscriptions.apip;ProfileSettings='User=your_api_key;Password=your_secret_key';");
MyCustomerInvoicesDAO dao = dbi.open(MyCustomerInvoicesDAO.class);

//do stuff with the DAO

dao.close();

Read PabblySubscriptions Data

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

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

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