Learn more
 

Create a Data Access Object for Drip Data using JDBI


A brief overview of creating a SQL Object API for Drip data in 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 Drip integrates connectivity to live Drip data in Java applications. By pairing these technologies, you gain simple, programmatic access to Drip data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read Drip data.

Create a DAO for the Drip Broadcasts 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 MyBroadcastsDAO { //request specific data from Drip (String type is used for simplicity) @SqlQuery("SELECT Name FROM Broadcasts WHERE Status = :status") String findNameByStatus(@Bind("status") String status); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Drip

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

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

Drip API Profile Settings

To use Token Authentication, specify your APIKey within the ProfileSettings connection property. The APIKey should be set to your Drip personal API Token.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Drip.apip;ProfileSettings='APIKey=my_api_token';

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\Drip.apip;ProfileSettings='APIKey=my_api_token';"); MyBroadcastsDAO dao = dbi.open(MyBroadcastsDAO.class); //do stuff with the DAO dao.close();

Read Drip Data

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

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

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

Ready to get started?

Connect to live data from Drip with the API Driver

Connect to Drip

In this article

Related articles