Connect to Clarifai Data in JRuby

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

Configure a JDBC Connection to Clarifai 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 Clarifai\lib).

JRuby natively supports JDBC, so you can easily connect to Clarifai 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 Clarifai Profile on disk (e.g. C:\profiles\Clarifai.apip). Next, set the ProfileSettings connection property to the connection string for Clarifai (see below).

Clarifai API Profile Settings

Clarifai uses Personal Access Tokens (PATs) for authentication. To obtain a PAT:

1. Log in to your Clarifai account at https://clarifai.com.
2. Navigate to your profile settings and select Security.
3. Click Create Personal Access Token.
4. Select the required scopes and click Create Token.
5. Copy the generated token (it will only be shown once).

After obtaining your Personal Access Token, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your Clarifai Personal Access Token (PAT).

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Clarifai 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 Clarifai:

jdbc:api:Profile=C:\profiles\Clarifai.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_access_token';

Create a JRuby App with Connectivity to Clarifai 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 Clarifai 2018/lib/cdata.jdbc.api.jar'

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

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

jruby -S APISelect.rb

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