VOOZH about

URL: https://www.cdata.com/kb/tech/excel-odbc-pycharm.rst

⇱ Using the CData ODBC Driver for Excel in PyCharm


Using the CData ODBC Driver for Excel in PyCharm

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Excel as an ODBC data source in PyCharm using the CData ODBC Driver for Excel.

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 Excel 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 Excel 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.
👁 Image

Connect to Excel

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.

Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) Excel Files

CData Drivers let you work with Excel files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.

Setting connection properties for local files

Set the URI property to local folder path.

Setting connection properties for files stored in Amazon S3

To connect to Excel file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended Excel files exist. In addition, at least set these properties:

  • AWSAccessKey: AWS Access Key (username)
  • AWSSecretKey: AWS Secret Key

Setting connection properties for files stored in Box

To connect to Excel file(s) within Box, set the URI property to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect to Box.

Dropbox

To connect to Excel file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.

SharePoint Online (SOAP)

To connect to Excel file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended Excel file. Set User, Password, and StorageBaseURL.

SharePoint Online REST

To connect to Excel file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended Excel file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.

Google Drive

To connect to Excel file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.

Below is the syntax for a DSN:

[CData Excel Source]
Driver = CData ODBC Driver for Excel
Description = My Description
URI = 'C:/MyExcelWorkbooks/SampleWorkbook.xlsx'

Execute SQL to Excel

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 Excel};URI = 'C:/MyExcelWorkbooks/SampleWorkbook.xlsx';')
cursor = cnxn.cursor()
cursor.execute("SELECT Name, Revenue FROM Sheet WHERE Name = 'Bob'")
rows = cursor.fetchall()
for row in rows:
 print(row.Name, row.Revenue)

After connecting to Excel in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Excel 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].

Ready to get started?

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

 Download Now

Learn more:

👁 Microsoft Excel Icon
Excel ODBC Driver

The Excel ODBC Driver is a powerful tool that allows you to connect with live Excel file data, directly from any applications that support ODBC connectivity.

Access Excel Spreadsheet data like you would a database - read, write, and update data through a standard ODBC Driver interface.