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

Create a DAO for the Apify ActorBuilds 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 MyActorBuildsDAO {
  //request specific data from Apify (String type is used for simplicity)
  @SqlQuery("SELECT ActorId FROM ActorBuilds WHERE Status = :status")
  String findActorIdByStatus(@Bind("status") String status);

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

Open a Connection to Apify

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

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

Apify API Profile Settings

Obtain your API token from the Apify Console by navigating to Settings and generating a new API token.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Apify Data

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

//disply the result of our 'find' method
String actorId = dao.findActorIdByStatus("SUCCEEDED");
System.out.println(actorId);

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