Using the CData ODBC Driver for SharePoint Excel Services in PyCharm

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for SharePoint Excel Services from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for SharePoint Excel Services as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

1. Click File -> Settings to open the project settings window.
2. Click Project Interpreter from the Project: YourProjectName menu.
3. To add pyodbc, click the + button and enter pyodbc.
4. Click Install Package to install pyodbc.

Connect to SharePoint Excel Services

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData ExcelServices Source]
Driver = CData ODBC Driver for SharePoint Excel Services
Description = My Description
URL = https://myorg.sharepoint.com
User = [email protected]
Password = password
File = Book1.xlsx

Execute SQL to SharePoint Excel Services

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for ExcelServices};URL = https://myorg.sharepoint.com;User = [email protected];Password = password;File = Book1.xlsx;')
cursor = cnxn.cursor()
cursor.execute("SELECT Name, AnnualRevenue FROM Account WHERE Industry = 'Floppy Disks'")
rows = cursor.fetchall()
for row in rows:
 print(row.Name, row.AnnualRevenue)

After connecting to SharePoint Excel Services in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to SharePoint Excel Services data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].