Connect to OData Services in JRuby

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

Getting Started

---

Configure a JDBC Connection to OData Services

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 OData\lib).

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

The User and Password properties, under the Authentication section, must be set to valid OData user credentials. In addition, specify a URL to a valid OData server organization root or OData services file.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the OData JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.odata.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for OData:

jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;

Create a JRuby App with Connectivity to OData Services

Create a new Ruby file (for example: ODataSelect.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 OData 2018/lib/cdata.jdbc.odata.jar'

url = "jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT OrderName, Freight FROM Orders")
while (rs.next) do
 puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S ODataSelect.rb

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