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

Create a DAO for the Delighted BouncedPeople 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 MyBouncedPeopleDAO {
  //request specific data from Delighted (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM BouncedPeople WHERE BouncedAt = :bouncedAt")
  String findNameByBouncedAt(@Bind("bouncedAt") String bouncedAt);

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

Open a Connection to Delighted

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

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

Delighted API Profile Settings

Your private API Key is linked to your Delighted account and can be obtained from your account administrator or the Delighted account settings.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Delighted Data

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

//disply the result of our 'find' method
String name = dao.findNameByBouncedAt("2026-01-15T10:30:00Z");
System.out.println(name);

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