Connect to Apollo Data in JRuby

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

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

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

Apollo API Profile Settings

Register an application with Apollo.io to obtain OAuth credentials from their developer console.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Apollo.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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

url = "jdbc:api:Profile=C:\profiles\Apollo.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, AccountStageId FROM Accounts")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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