Connect to Egnyte Data in JRuby

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

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

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

Egnyte API Profile Settings

Register a developer account with Egnyte and create an OAuth application to receive a Client ID and Secret. Your domain is extracted from your Egnyte URL.

Built-in Connection String Designer

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

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

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

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

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

jruby -S APISelect.rb

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