How to import OneNote Data into Apache Solr

The Apache Solr platform is a popular, blazing-fast, open source enterprise search solution built on Apache Lucene.

Apache Solr is equipped with the Data Import Handler (DIH), which can import data from databases and, XML, CSV, and JSON files. When paired with the CData JDBC Driver for OneNote, you can easily import OneNote data to Apache Solr. In this article, we show step-by-step how to use CData JDBC Driver in Apache Solr Data Import Handler and import OneNote data for use in enterprise search.

Create an Apache Solr Core and a Schema for Importing OneNote

1. Run Apache Solr and create a Core.

   > solr create -c CDataCore

   For this article, Solr is running as a standalone instance in the local environment and you can access the core at this URL: http://localhost:8983/solr/#/CDataCore/core-overview
2. Create a schema consisting of "field" objects to represent the columns of the OneNote data to be imported and a unique key for the entity. LastModifiedDate, if it exists in OneNote, is used for incremental updates. If it does not exist, you cannot do the deltaquery in the later section. Save the schema in the managed-schema file created by Apache Solr.

	OneNoteUniqueKey
	
	
	
	
	
	
	
	 
	

👁 Define schema in Solr for OneNote data.

3. Install the CData OneNote JDBC Driver. Copy the JAR and license file (cdata.onenote.jar and cdata.jdbc.onenote.lic) to the Solr directory.
   
   • CData JDBC JAR file: C:\Program Files\CData\CData JDBC Driver for OneNote ####\lib
   • Apache Solr: solr-8.5.2\server\lib

Now we are ready to use OneNote data in Solr.

Define an Import of OneNote to Apache Solr

In this section, we walk through configuring the Data Import Handler.

1. Modify the Config file of the created Core. Add the JAR file reference and add the DIH RequestHander definition.

   	
   
   	<lib dir="${solr.install.dir:../../../..}/dist/" regex="solr-dataimporthandler-.*\.jar" />
   
   	<requestHandler name="/dataimport" class="org.apache.solr.handler.dataimport.DataImportHandler">
   		<lst name="defaults">
   			<str name="config">solr-data-config.xml</str>
   		</lst>
   	</requestHandler>

2. Next, create a solr-data-config.xml at the same level. In this article, we retrieve a table from OneNote, but you can use a custom SQL query to request data as well. The Driver Class and a sample JDBC Connection string are in the sample code below.

   	
   	<dataConfig>
   		<dataSource driver="cdata.jdbc.onenote.OneNoteDriver" url="jdbc:onenote:OAuthClientId=MyApplicationId; OAuthClientSecret=MySecretKey; CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;">
   		</dataSource> 
   		<document> 
   			<entity name="Notebooks" 
   				query="SELECT Id,OneNoteColumn1,OneNoteColumn2,OneNoteColumn3,OneNoteColumn4,OneNoteColumn5,OneNoteColumn6,OneNoteColumn7,LastModifiedDate FROM Notebooks"
   				deltaQuery="SELECT Id FROM Notebooks where LastModifiedDate >= '${dataimporter.last_index_time}'"
   				deltaImportQuery="SELECT Id,OneNoteColumn1,OneNoteColumn2,OneNoteColumn3,OneNoteColumn4,OneNoteColumn5,OneNoteColumn6,OneNoteColumn7,LastModifiedDate FROM Notebooks where Id=${dataimporter.delta.Id}">
   				<field column="Id" name="Id" ></field>
   				<field column="OneNoteColumn1" name="OneNoteColumn1" ></field>
   				<field column="OneNoteColumn2" name="OneNoteColumn2" ></field>
   				<field column="OneNoteColumn3" name="OneNoteColumn3" ></field>
   				<field column="OneNoteColumn4" name="OneNoteColumn4" ></field>
   				<field column="OneNoteColumn5" name="OneNoteColumn5" ></field>
   				<field column="OneNoteColumn6" name="OneNoteColumn6" ></field>
   				<field column="OneNoteColumn7" name="OneNoteColumn7" ></field>
   				<field column="LastModifiedDate" name="LastModifiedDate" ></field> 
   			</entity>
   		</document>
   	</dataConfig>

3. In the query section, set the SQL query that select the data from OneNote. deltaQuery and deltaImportquery define the ID and the conditions when using incremental updates from the second import of the same entity.
4. After all settings are done, restart Solr.

   	> solr stop -all
   	> solr start
   	

Run a DataImport of OneNote Data.

1. Execute DataImport from the URL below:
   http://localhost:8983/solr/#/CDataCore/dataimport//dataimport 👁 Load OneNote data to Solr using Data Import.
   
2. Select the "full-import" Command, choose the table from Entity, and click "Execute." 👁 Execute full import in Solr.
   
3. Check the result of the import from the Query. 👁 Check the full import result of OneNote.
   
4. Try an incremental update using deltaQuery. Modify some data in the original OneNote data set. Select the "delta-import" command this time from DataImport window and click "Execute." 👁 Execute Delta import in Solr.
   
5. Check the result of the incremental update. 👁 Check the delta import result of OneNote.
   

Using the CData JDBC Driver for OneNote you are able to create an automated import of OneNote data into Apache Solr. Download a free, 30 day trial of any of the hundreds of CData JDBC Drivers and get started today.