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

Create a DAO for the Abyssale Designs 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 MyDesignsDAO {
  //request specific data from Abyssale (String type is used for simplicity)
  @SqlQuery("SELECT Name FROM Designs WHERE Type = :type")
  String findNameByType(@Bind("type") String type);

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

Open a Connection to Abyssale

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

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

Abyssale API Profile Settings

Abyssale uses API Key authentication. Your Abyssale API Key is sent as the x-api-key request header. You can generate or view your API Key in the Abyssale dashboard under Settings > API.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Abyssale API Key.

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Abyssale Data

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

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

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