Create a Data Access Object for Highrise Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Highrise JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Highrise account data including Accounts, Deals, Emails, People, Tasks, and more!



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

Create a DAO for the Highrise Deals 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 MyDealsDAO { //insert new data into Highrise @SqlUpdate("INSERT INTO Deals (GroupId, Price) values (:groupId, :price)") void insert(@Bind("groupId") String groupId, @Bind("price") String price); //request specific data from Highrise (String type is used for simplicity) @SqlQuery("SELECT Price FROM Deals WHERE GroupId = :groupId") String findPriceByGroupId(@Bind("groupId") String groupId); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Highrise

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

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in 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 Highrise JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.highrise.jar

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

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

jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;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:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH"); MyDealsDAO dao = dbi.open(MyDealsDAO.class); //do stuff with the DAO dao.close();

Read Highrise Data

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

//disply the result of our 'find' method String price = dao.findPriceByGroupId("MyGroupId"); System.out.println(price);

Write Highrise Data

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

//add a new entry to the Deals entity dao.insert(newGroupId, newPrice);

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