Connect to Perigon Data in JRuby

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

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

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

Using API Key Authentication

To use the Perigon API, you need to obtain an API key from your Perigon account. Navigate to the Perigon dashboard and generate an API key from your account settings.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Perigon API key.

Example connection string:

Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

Available Tables

The Perigon profile provides access to the following tables:

• Articles - News articles retrieved from the Perigon news intelligence API
• Headlines - Story clusters grouping related headline articles
• Sources - News sources tracked by the Perigon news intelligence API
• Journalists - Journalist profiles tracked by the Perigon news intelligence API

Built-in Connection String Designer

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

jdbc:api:Profile=C:\profiles\Perigon.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

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

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

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

jruby -S APISelect.rb

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