Ready to get started?

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

 Download Now

Learn more:

Microsoft OneNote Icon OneNote JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft OneNote data including Notebooks, Notes, Searches, Tags, and more!

How to work with OneNote Data in Apache Spark using SQL

Access and process OneNote Data in Apache Spark using the CData JDBC Driver.

Apache Spark is a fast and general engine for large-scale data processing. When paired with the CData JDBC Driver for OneNote, Spark can work with live OneNote data. This article describes how to connect to and query OneNote data from a Spark shell.

The CData JDBC Driver offers unmatched performance for interacting with live OneNote data due to optimized data processing built into the driver. When you issue complex SQL queries to OneNote, the driver pushes supported SQL operations, like filters and aggregations, directly to OneNote and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can work with and analyze OneNote data using native data types.

Install the CData JDBC Driver for OneNote

Download the CData JDBC Driver for OneNote installer, unzip the package, and run the JAR file to install the driver.

Start a Spark Shell and Connect to OneNote Data

  1. Open a terminal and start the Spark shell with the CData JDBC Driver for OneNote JAR file as the jars parameter: $ spark-shell --jars /CData/CData JDBC Driver for OneNote/lib/cdata.jdbc.onenote.jar
  2. With the shell running, you can connect to OneNote with a JDBC URL and use the SQL Context load() function to read a table.

    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.

    Configure the connection to OneNote, using the connection string generated above.

    scala> val onenote_df ="jdbc").option("url", "jdbc:onenote:OAuthClientId=MyApplicationId; OAuthClientSecret=MySecretKey; CallbackURL=http://localhost:33333;").option("dbtable","Notebooks").option("driver","cdata.jdbc.onenote.OneNoteDriver").load()
  3. Once you connect and the data is loaded you will see the table schema displayed.
  4. Register the OneNote data as a temporary table:

    scala> onenote_df.registerTable("notebooks")
  5. Perform custom SQL queries against the Data using commands like the one below:

    scala> onenote_df.sqlContext.sql("SELECT Id, notebook_displayName FROM Notebooks WHERE Id = Jq74mCczmFXk1tC10GB").collect.foreach(println)

    You will see the results displayed in the console, similar to the following:

Using the CData JDBC Driver for OneNote in Apache Spark, you are able to perform fast and complex analytics on OneNote data, combining the power and utility of Spark with your data. Download a free, 30 day trial of any of the 200+ CData JDBC Drivers and get started today.