Connect to Carbone Data in JRuby

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

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

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

Carbone API Profile Settings

Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

1. Log in to your Carbone account at https://account.carbone.io
2. Copy the API key shown on the account home page

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Carbone API key (Bearer token).
• CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Carbone.apip;AuthScheme=APIKey;APIKey=your_api_key;

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

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

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

jruby -S APISelect.rb

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