Learn more
 

Ready to get started?

Download a free trial of the Cosmos DB Driver to get started:

 Download Now

Learn more:

Cosmos DB Icon Cosmos DB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Cosmos DB document databases.

In this article

Related articles

Use JayDeBeApi to access Cosmos DB Data in Python


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

Access Cosmos DB 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 Cosmos DB and the JayDeBeApi module to work with remote Cosmos DB 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 Cosmos DB and visualize Cosmos DB 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 Cosmos DB data in Python using SQL.

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.

Built-in Connection String Designer

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

java -jar cdata.jdbc.cosmosdb.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:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;"

Access Cosmos DB 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.cosmosdb.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 Cosmos DB:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;" 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.cosmosdb.jar" conn = jaydebeapi.connect( "cdata.jdbc.cosmosdb.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Customers;") 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 Cosmos DB and start working with your live Cosmos DB data in Python. Reach out to our Support Team if you have any questions.