Connect to Avaza Data in JRuby

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

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

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

Avaza API Profile Settings

Register an OAuth application in Avaza under Settings > Manage Developer Apps > OAuth 2 Apps > Add OAuth App to obtain your client ID and secret credentials.

Built-in Connection String Designer

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

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

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

url = "jdbc:api:Profile=C:\profiles\Avaza.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, CompanyName FROM Account")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S APISelect.rb

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