Connect to Simplesat Data in JRuby

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a simple JRuby app with access to live Simplesat data.

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

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

JRuby natively supports JDBC, so you can easily connect to Simplesat and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

Using API Key Authentication

Simplesat uses API Key authentication. To obtain your API key, log in to your Simplesat account and navigate to Workspace Settings > API. Copy the API key value for use in the connection string.

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

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Simplesat API key obtained from workspace settings.

Built-in Connection String Designer

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

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

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

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

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

jruby -S APISelect.rb

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

Ready to get started?

Connect to live data from Simplesat with the API Driver

Connect to Simplesat