Using the CData ODBC Driver for Cosmos DB in PyCharm

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Cosmos DB ODBC Driver

The Cosmos DB ODBC Driver is a powerful tool that allows you to connect with live Cosmos DB document databases, directly from any applications that support ODBC connectivity.

Access Cosmos DB like you would a database - read, write, and update through a standard ODBC Driver interface.



Connect to Cosmos DB as an ODBC data source in PyCharm using the CData ODBC Driver for Cosmos DB.

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 Cosmos DB 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 Cosmos DB 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 Cosmos DB

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.

To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

  • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
  • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

Below is the syntax for a DSN:

[CData CosmosDB Source] Driver = CData ODBC Driver for Cosmos DB Description = My Description AccountEndpoint = myAccountEndpoint AccountKey = myAccountKey

Execute SQL to Cosmos DB

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 CosmosDB};AccountEndpoint = myAccountEndpoint;AccountKey = myAccountKey;') cursor = cnxn.cursor() cursor.execute("SELECT City, CompanyName FROM Customers WHERE Name = 'Morris Park Bake Shop'") rows = cursor.fetchall() for row in rows: print(row.City, row.CompanyName)

After connecting to Cosmos DB in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Cosmos DB data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.