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

Create a DAO for the MailerLite Account 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 MyAccountDAO {
  //request specific data from MailerLite (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Account WHERE Email = :email")
  String findNameByEmail(@Bind("email") String email);

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

Open a Connection to MailerLite

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

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

MailerLite API Profile Settings

Obtain your API Key from the Integrations page in your MailerLite account dashboard.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read MailerLite Data

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

//disply the result of our 'find' method
String name = dao.findNameByEmail("[email protected]");
System.out.println(name);

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