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

Create a DAO for the Attio AttributeOptions 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 MyAttributeOptionsDAO {
  //request specific data from Attio (String type is used for simplicity)
  @SqlQuery("SELECT WorkspaceId FROM AttributeOptions WHERE IsArchived = :isArchived")
  String findWorkspaceIdByIsArchived(@Bind("isArchived") String isArchived);

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

Open a Connection to Attio

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

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

Attio API Profile Settings

Obtain your API key from your Attio account settings. Navigate to Settings > API Keys to generate and copy a new access token.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Attio Data

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

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

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