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

Create a DAO for the Guru Analytics 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 MyAnalyticsDAO {
  //request specific data from Guru (String type is used for simplicity)
  @SqlQuery("SELECT Type FROM Analytics WHERE TeamId = :teamId")
  String findTypeByTeamId(@Bind("teamId") String teamId);

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

Open a Connection to Guru

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

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

Guru API Profile Settings

In Guru, navigate to Settings > API and click Create New API Token. Use your email address as the User and the generated token as the Password.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Guru.apip;ProfileSettings='User=your_email;Password=your_api_token';

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\Guru.apip;ProfileSettings='User=your_email;Password=your_api_token';");
MyAnalyticsDAO dao = dbi.open(MyAnalyticsDAO.class);

//do stuff with the DAO

dao.close();

Read Guru Data

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

//disply the result of our 'find' method
String type = dao.findTypeByTeamId("team-12345");
System.out.println(type);

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