Ready to get started?

Learn more about the CData ODBC Driver for OneNote or download a free trial:

Download Now

Connect to OneNote Data in Ruby

Connect to OneNote data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

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

Create an ODBC Connection to OneNote 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.

OneNote uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation for more information.

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 OneNote Data

Create a new Ruby file (for example: OneNoteSelect.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 OneNote Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, notebook_displayName FROM Notebooks WHERE Id = 'Jq74mCczmFXk1tC10GB'") #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 OneNote data with Ruby. To do so, simply run your file from the command line:

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