How to import OData Services into Apache Solr



Use the CData JDBC Driver for OData in Data Import Handler and create an automated import of OData services to Apache Solr Enterprise Search platform.

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 OData, you can easily import OData services 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 OData services for use in enterprise search.

About OData Data Integration

CData simplifies access and integration of live OData services data. Our customers leverage CData connectivity to:

  • Access OData versions 2.0, 3.0, and 4.0, working with legacy services and the latest features and capabilities.
  • Leverage advanced query options, including $filter, $select, and $expand, enhancing data retrieval from 3rd party tools.
  • Use Server-side execution of aggregation and grouping to minimize data transfer and boost performance.
  • Authenticate securely using a variety of schemes, including Azure AD, digest, negotiate, NTLM, OAuth, and more means secure authentication with every connection.
  • Use SQL stored procedures to manage OData service entities - listing, creating, and removing associations between entities.

Customers use CData's solutions to regularly integrate their OData services with preferred tools, such as Power BI, MicroStrategy, or Tableau, and to replicate data from OData services to their databases or data warehouses.


Getting Started


Create an Apache Solr Core and a Schema for Importing OData

  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 OData services to be imported and a unique key for the entity. LastModifiedDate, if it exists in OData, 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.
  3. ODataUniqueKey
  4. Install the CData OData JDBC Driver. Copy the JAR and license file (cdata.odata.jar and cdata.jdbc.odata.lic) to the Solr directory.
    • CData JDBC JAR file: C:\Program Files\CData\CData JDBC Driver for OData ####\lib
    • Apache Solr: solr-8.5.2\server\lib

Now we are ready to use OData services in Solr.

Define an Import of OData 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 OData, 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.odata.ODataDriver" url="jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;"> </dataSource> <document> <entity name="Orders" query="SELECT Id,ODataColumn1,ODataColumn2,ODataColumn3,ODataColumn4,ODataColumn5,ODataColumn6,ODataColumn7,LastModifiedDate FROM Orders" deltaQuery="SELECT Id FROM Orders where LastModifiedDate >= '${dataimporter.last_index_time}'" deltaImportQuery="SELECT Id,ODataColumn1,ODataColumn2,ODataColumn3,ODataColumn4,ODataColumn5,ODataColumn6,ODataColumn7,LastModifiedDate FROM Orders where Id=${dataimporter.delta.Id}"> <field column="Id" name="Id" ></field> <field column="ODataColumn1" name="ODataColumn1" ></field> <field column="ODataColumn2" name="ODataColumn2" ></field> <field column="ODataColumn3" name="ODataColumn3" ></field> <field column="ODataColumn4" name="ODataColumn4" ></field> <field column="ODataColumn5" name="ODataColumn5" ></field> <field column="ODataColumn6" name="ODataColumn6" ></field> <field column="ODataColumn7" name="ODataColumn7" ></field> <field column="LastModifiedDate" name="LastModifiedDate" ></field> </entity> </document> </dataConfig>
  3. In the query section, set the SQL query that select the data from OData. 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 OData Services.

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

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

Ready to get started?

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

 Download Now

Learn more:

OData Icon OData JDBC Driver

Easy-to-use OData client (consumer) enables developers to build Java applications that easily communicate with OData services.