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

Create a DAO for the Parallel MonitorEvents 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 MyMonitorEventsDAO {
  //request specific data from Parallel (String type is used for simplicity)
  @SqlQuery("SELECT  FROM MonitorEvents WHERE MonitorId = :monitorId")
  String findByMonitorId(@Bind("monitorId") String monitorId);

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

Open a Connection to Parallel

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

The Parallel API uses API Key authentication via the x-api-key request header.

Using API Key Authentication

Your Parallel API key is required to create a connection. To obtain your API key:

1. Log into your Parallel account at app.parallel.ai.
2. Navigate to Settings or API Keys in your account dashboard.
3. Generate or copy your API key.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Parallel API key.

Example connection string:

Profile=C:\profiles\Parallel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Parallel Data

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

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

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