Connect to Close Data in JRuby

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

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

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

Close API Profile Settings

Locate your API key through Close's Settings menu under Your API Keys and create a new key if needed.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Close.apip;ProfileSettings='APIKey=your_api_key';

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

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

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

jruby -S APISelect.rb

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