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

Create a DAO for the Templated Account 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 MyAccountDAO {
  //request specific data from Templated (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Account WHERE  = :")
  String findBy(@Bind("") String );

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

Open a Connection to Templated

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

To authenticate to Templated, you will need an API key. You can obtain your API key from the Templated Dashboard under the API Key tab (app.templated.io > Dashboard > API Key).

Using API Key Authentication

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

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

Example connection string:

Profile=C:\profiles\Templated.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Templated Data

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

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

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