Connect to Quaderno Data in JRuby

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

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

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

Quaderno API Profile Settings

Find your API Key in your Quaderno account under Developers > API Keys > Private Key. Your AccountName is the subdomain of your Quaderno URL.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Quaderno.apip;ProfileSettings='APIKey=your_api_key;AccountName=your_account_name';

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

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

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

jruby -S APISelect.rb

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