Connect to Excel Online Data in Ruby

The CData ODBC Driver for Excel Online makes it easy to integrate connectivity to live Excel Online data in Ruby. This article shows how to create a simple Ruby app that connects to Excel Online data, executes a query, and displays the results.

Create an ODBC Connection to Excel Online Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

You can connect to a workbook by providing authentication to Excel Online and then setting the following properties:

• : Set this to the name or Id of the workbook.

  If you want to view a list of information about the available workbooks, execute a query to the Workbooks view after you authenticate.

• : Set this to true if you are connecting to a workbook in a sandbox account. Otherwise, leave this blank to connect to a production account.

You use the OAuth authentication standard to authenticate to Excel Online. See the Getting Started section in the help documentation for a guide. Getting Started also guides you through executing SQL to worksheets and ranges.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi
gem install dbd-odbc
gem install ruby-odbc

Create a Ruby App with Connectivity to Excel Online Data

Create a new Ruby file (for example: ExcelOnlineSelect.rb) and open it in a text editor. Copy the following code into your file:

#connect to the DSN
require 'dbi'
cnxn = DBI.connect('DBI:ODBC:CData ExcelOnline Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Id, Column1 FROM Test_xlsx_Sheet1")

#display the names of the columns
resultSet.column_names.each do |name|
 print name, "\t"
end
puts

#display the results
while row = resultSet.fetch do
 (0..resultSet.column_names.size - 1).each do |n|
 print row[n], "\t"
 end
 puts
end
resultSet.finish

#close the connection
cnxn.disconnect if cnxn

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

ruby ExcelOnlineSelect.rb

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