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

Create a DAO for the Amplitude ChartAnnotations 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 MyChartAnnotationsDAO {
  //request specific data from Amplitude (String type is used for simplicity)
  @SqlQuery("SELECT Date FROM ChartAnnotations WHERE Id = :id")
  String findDateById(@Bind("id") String id);

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

Open a Connection to Amplitude

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

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

Amplitude API Profile Settings

Retrieve your API Key and Secret Key from your Amplitude project's Settings page. Both values are required for authenticating API requests.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Amplitude Data

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

//disply the result of our 'find' method
String date = dao.findDateById("12345");
System.out.println(date);

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