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

Getting Started

---

Create a DAO for the HubSpot Prospects 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 MyProspectsDAO {
 //insert new data into HubSpot
 @SqlUpdate("INSERT INTO Prospects (Region, PageViews) values (:region, :pageViews)")
 void insert(@Bind("region") String region, @Bind("pageViews") String pageViews);

 //request specific data from HubSpot (String type is used for simplicity)
 @SqlQuery("SELECT PageViews FROM Prospects WHERE Region = :region")
 String findPageViewsByRegion(@Bind("region") String region);

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

Open a Connection to HubSpot

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

HubSpot uses the OAuth authentication standard. You can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL or you can obtain your own by registering an app.

See the Getting Started chapter of the help documentation for a guide to using OAuth.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the HubSpot JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.hubspot.jar

Fill in the connection properties and copy the connection string to the clipboard.

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

A connection string for HubSpot will typically look like the following:

jdbc:hubspot:InitiateOAuth=GETANDREFRESH;

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:hubspot:InitiateOAuth=GETANDREFRESH;");
MyProspectsDAO dao = dbi.open(MyProspectsDAO.class);

//do stuff with the DAO

dao.close();

Read HubSpot Data

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

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

Write HubSpot Data

It is also simple to write data to HubSpot, using the previously defined method.

//add a new entry to the Prospects entity
dao.insert(newRegion, newPageViews);

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