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

Create a DAO for the Deepgram Keys 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 MyKeysDAO {
  //request specific data from Deepgram (String type is used for simplicity)
  @SqlQuery("SELECT MemberEmail FROM Keys WHERE ProjectId = :projectId")
  String findMemberEmailByProjectId(@Bind("projectId") String projectId);

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

Open a Connection to Deepgram

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

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

Deepgram API Profile Settings

Deepgram uses API key authentication for all endpoints. API keys are scoped to a project and carry permission scopes (member, administrator, or owner). Create and manage API keys in the Deepgram console.

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

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

Built-in Connection String Designer

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

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

//do stuff with the DAO

dao.close();

Read Deepgram Data

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

//disply the result of our 'find' method
String memberEmail = dao.findMemberEmailByProjectId("your-project-id");
System.out.println(memberEmail);

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