Query OneNote Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for OneNote, DataGrip can work with live OneNote data. This article shows how to establish a connection to OneNote data in DataGrip and use the table editor to load OneNote data.

Create a New Driver Definition for OneNote

The steps below describe how to create a new Data Source in DataGrip for OneNote.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData OneNote Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.onenote.jar).
   • Set Class to cdata.jdbc.onenote.OneNote.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to OneNote

1. Once the connection is saved, click the plus (), then "Data Source" then "CData OneNote Driver" to create a new OneNote Data Source.
2. In the new window, configure the connection to OneNote with a JDBC URL.

   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.

   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.

3. Set URL to the connection string, e.g., jdbc:onenote:OAuthClientId=MyApplicationId; OAuthClientSecret=MySecretKey; CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against OneNote

To browse through the OneNote entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Id, notebook_displayName FROM Notebooks WHERE Id = 'Jq74mCczmFXk1tC10GB'

Download a free, 30-day trial of the CData JDBC Driver for OneNote and start working with your live OneNote data in DataGrip. Reach out to our Support Team if you have any questions.