Ready to get started?

Download a free trial of the SharePoint Excel Services Driver to get started:

 Download Now

Learn more:

SharePoint Excel Services Icon SharePoint Excel Services JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with live Excel Spreadsheet content hosted on SharePoint server!

How to connect and process SharePoint Excel Services Data from Azure Databricks

Use CData, Azure, and Databricks to perform data engineering and data science on live SharePoint Excel Services Data

Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live SharePoint Excel Services data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live SharePoint Excel Services data in Databricks.

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

Install the CData JDBC Driver in Azure

To work with live SharePoint Excel Services data in Databricks, install the driver on your Azure cluster.

  1. Navigate to your Databricks administration screen and select the target cluster.
  2. On the Libraries tab, click "Install New."
  3. Select "Upload" as the Library Source and "Jar" as the Library Type.
  4. Upload the JDBC JAR file (cdata.jdbc.excelservices.jar) from the installation location (typically C:\Program Files\CData[product_name]\lib).

Connect to SharePoint Excel Services from Databricks

With the JAR file installed, we are ready to work with live SharePoint Excel Services data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query SharePoint Excel Services, and create a basic report.

Configure the Connection to SharePoint Excel Services

Connect to SharePoint Excel Services by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the RTK property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.

driver = "cdata.jdbc.excelservices.ExcelServicesDriver"
url = "jdbc:excelservices:RTK=5246...;URL=;;Password=password;File=Book1.xlsx;"

Built-in Connection String Designer

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

java -jar cdata.jdbc.excelservices.jar

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

The URL, User, and Password properties, under the Authentication section, must be set to valid credentials for SharePoint Online, SharePoint 2010, or SharePoint 2013. Additionally, the Library property must be set to a valid SharePoint Document Library and the File property must be set to a valid .xlsx file in the indicated Library.

Load SharePoint Excel Services Data

Once the connection is configured, you can load SharePoint Excel Services data as a dataframe using the CData JDBC Driver and the connection information.

remote_table = ( "jdbc" ) \
	.option ( "driver" , driver) \
	.option ( "url" , url) \
	.option ( "dbtable" , "Account") \
	.load ()

Display SharePoint Excel Services Data

Check the loaded SharePoint Excel Services data by calling the display function.

display ( ("Name"))

Analyze SharePoint Excel Services Data in Azure Databricks

If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.

remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )

The SparkSQL below retrieves the SharePoint Excel Services data for analysis.

% sql

SELECT Name, AnnualRevenue FROM Account

The data from SharePoint Excel Services is only available in the target notebook. If you want to use it with other users, save it as a table.

remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )

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