VOOZH about

URL: https://www.cdata.com/kb/tech/excel-jdbc-jruby.rst

⇱ Connect to Excel Data in JRuby


Connect to Excel Data in JRuby

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

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

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

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

Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) Excel Files

CData Drivers let you work with Excel files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.

Setting connection properties for local files

Set the URI property to local folder path.

Setting connection properties for files stored in Amazon S3

To connect to Excel file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended Excel files exist. In addition, at least set these properties:

  • AWSAccessKey: AWS Access Key (username)
  • AWSSecretKey: AWS Secret Key

Setting connection properties for files stored in Box

To connect to Excel file(s) within Box, set the URI property to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect to Box.

Dropbox

To connect to Excel file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.

SharePoint Online (SOAP)

To connect to Excel file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended Excel file. Set User, Password, and StorageBaseURL.

SharePoint Online REST

To connect to Excel file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended Excel file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.

Google Drive

To connect to Excel file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.

Built-in Connection String Designer

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

java -jar cdata.jdbc.excel.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Below is a typical JDBC connection string for Excel:

jdbc:excel:URI='C:/MyExcelWorkbooks/SampleWorkbook.xlsx';

Create a JRuby App with Connectivity to Excel Data

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

url = "jdbc:excel:URI='C:/MyExcelWorkbooks/SampleWorkbook.xlsx';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Name, Revenue FROM Sheet")
while (rs.next) do
 puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S ExcelSelect.rb

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

Ready to get started?

Download a free trial of the Excel Driver to get started:

 Download Now

Learn more:

👁 Microsoft Excel Icon
Microsoft Excel JDBC Driver

Easily connect Java/J2EE applications with real-time data from Excel spreadsheets. Use Excel to manage the data that powers your applications.