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

Create a DAO for the Buildkite Builds 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 MyBuildsDAO {
  //request specific data from Buildkite (String type is used for simplicity)
  @SqlQuery("SELECT BuildNumber FROM Builds WHERE State = :state")
  String findBuildNumberByState(@Bind("state") String state);

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

Open a Connection to Buildkite

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

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

Buildkite API Profile Settings

Buildkite uses HTTP API key authentication. Your Buildkite API access token is used to authenticate requests as a Bearer token. You can generate or view your tokens at https://buildkite.com/user/api-access-tokens.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Buildkite API access token.
• Organization: Set this to your Buildkite organization slug (e.g. acme-inc).

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Buildkite.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Organization=your_organization_slug';

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\Buildkite.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Organization=your_organization_slug';");
MyBuildsDAO dao = dbi.open(MyBuildsDAO.class);

//do stuff with the DAO

dao.close();

Read Buildkite Data

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

//disply the result of our 'find' method
String buildNumber = dao.findBuildNumberByState("passed");
System.out.println(buildNumber);

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