Learn more
 

Use JayDeBeApi to access Excel Online Data in Python


Use standard Python scripting and the development environment of your choice to access live Excel Online data.

Access Excel Online data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for Excel Online and the JayDeBeApi module to work with remote Excel Online data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to Excel Online and visualize Excel Online data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with Excel Online data in Python using SQL.

You can connect to a workbook by providing authentication to Excel Online and then setting the following properties:

  • Workbook: Set this to the name or Id of the workbook.

    If you want to view a list of information about the available workbooks, execute a query to the Workbooks view after you authenticate.

  • UseSandbox: Set this to true if you are connecting to a workbook in a sandbox account. Otherwise, leave this blank to connect to a production account.

You use the OAuth authentication standard to authenticate to Excel Online. See the Getting Started section in the help documentation for a guide. Getting Started also guides you through executing SQL to worksheets and ranges.

Built-in Connection String Designer

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

java -jar cdata.jdbc.excelonline.jar

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

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:excelonline:InitiateOAuth=GETANDREFRESH"

Access Excel Online data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.excelonline.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from Excel Online:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:excelonline:InitiateOAuth=GETANDREFRESH" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.excelonline.jar" conn = jaydebeapi.connect( "cdata.jdbc.excelonline.ExcelOnlineDriver", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Test_xlsx_Sheet1;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

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

Ready to get started?

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

 Download Now

Learn more:

Excel Online Icon Excel Online JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with live Excel Online Spreadsheet data!

In this article

Related articles