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

Create a DAO for the SendGrid AdvancedStats 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 MyAdvancedStatsDAO {
 //insert new data into SendGrid
 @SqlUpdate("INSERT INTO AdvancedStats (Type, Clicks) values (:type, :clicks)")
 void insert(@Bind("type") String type, @Bind("clicks") String clicks);

 //request specific data from SendGrid (String type is used for simplicity)
 @SqlQuery("SELECT Clicks FROM AdvancedStats WHERE Type = :type")
 String findClicksByType(@Bind("type") String type);

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

Open a Connection to SendGrid

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

To make use of all the available features, provide the User and Password connection properties.

To connect with limited features, you can set the APIKey connection property instead. See the "Getting Started" chapter of the help documentation for a guide to obtaining the API key.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sendgrid.jar

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

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

jdbc:sendgrid:User=admin;Password=abc123;

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:sendgrid:User=admin;Password=abc123;");
MyAdvancedStatsDAO dao = dbi.open(MyAdvancedStatsDAO.class);

//do stuff with the DAO

dao.close();

Read SendGrid Data

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

//disply the result of our 'find' method
String clicks = dao.findClicksByType("Device");
System.out.println(clicks);

Write SendGrid Data

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

//add a new entry to the AdvancedStats entity
dao.insert(newType, newClicks);

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