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

Create a DAO for the BenchmarkEmail ABTestDetails 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 MyABTestDetailsDAO {
  //request specific data from BenchmarkEmail (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM ABTestDetails 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 BenchmarkEmail

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

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

BenchmarkEmail API Profile Settings

Navigate to Integrations > API Key in your BenchmarkEmail account to obtain the API Key.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Benchmarkemail.apip;ProfileSettings='APIKey=your_api_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\Benchmarkemail.apip;ProfileSettings='APIKey=your_api_key';");
MyABTestDetailsDAO dao = dbi.open(MyABTestDetailsDAO.class);

//do stuff with the DAO

dao.close();

Read BenchmarkEmail Data

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

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

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