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

Create a DAO for the Clockify ApprovalRequests 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 MyApprovalRequestsDAO {
  //request specific data from Clockify (String type is used for simplicity)
  @SqlQuery("SELECT WorkspaceId FROM ApprovalRequests WHERE StatusState = :statusState")
  String findWorkspaceIdByStatusState(@Bind("statusState") String statusState);

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

Open a Connection to Clockify

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

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

Clockify API Profile Settings

Log into your Clockify account, navigate to Profile Settings, and copy the API key from the API section.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Clockify Data

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

//disply the result of our 'find' method
String workspaceId = dao.findWorkspaceIdByStatusState("PENDING");
System.out.println(workspaceId);

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