Connect to CleverPush Data in JRuby

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

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

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

Cleverpush API Profile Settings

CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CleverPush private API key.

Optional Connection Properties

• ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Cleverpush.apip;ProfileSettings='APIKey=my_api_key';

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

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

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

jruby -S APISelect.rb

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