Ready to get started?

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

Download Now

Connect to OneNote Data in JRuby

Create a simple JRuby app with access to live OneNote data.

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

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

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

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.

Built-in Connection String Designer

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

java -jar cdata.jdbc.onenote.jar

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

Below is a typical JDBC connection string for OneNote:

jdbc:onenote:OAuthClientId=MyApplicationId; OAuthClientSecret=MySecretKey; CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH

Create a JRuby 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:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for OneNote 2018/lib/cdata.jdbc.onenote.jar' url = "jdbc:onenote:OAuthClientId=MyApplicationId; OAuthClientSecret=MySecretKey; CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Id, notebook_displayName FROM Notebooks") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S OneNoteSelect.rb

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