Connect to Deepgram Data in JRuby

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Deepgram makes it easy to integrate connectivity to live Deepgram data in JRuby. This article shows how to create a simple JRuby app that connects to Deepgram data, executes a query, and displays the results.

Configure a JDBC Connection to Deepgram Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Deepgram\lib).

JRuby natively supports JDBC, so you can easily connect to Deepgram and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

Below is a typical JDBC connection string for Deepgram:

jdbc:api:Profile=C:\profiles\Deepgram.apip;AuthScheme=APIKey;ProfileSettings='APIKey=YOUR_DEEPGRAM_API_KEY';

Create a JRuby App with Connectivity to Deepgram Data

Create a new Ruby file (for example: APISelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java'
require 'rubygems'
require 'C:/Program Files/CData/CData JDBC Driver for Deepgram 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\Deepgram.apip;AuthScheme=APIKey;ProfileSettings='APIKey=YOUR_DEEPGRAM_API_KEY';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT ApiKeyId, MemberEmail FROM Keys")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

With the file completed, you are ready to display your Deepgram data with JRuby. To do so, simply run your file from the command line:

jruby -S APISelect.rb

Writing SQL-92 queries to Deepgram allows you to quickly and easily incorporate Deepgram data into your own JRuby applications. Download a free trial today!