Connect to SparkPost Data in JRuby

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

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

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

SparkPost API Profile Settings

Generate an API key by navigating to Configuration > API Keys > Create API Key in your SparkPost account.

Built-in Connection String Designer

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

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

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

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

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

jruby -S APISelect.rb

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