Learn more
 

Use JayDeBeApi to access CockroachDB Data in Python


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

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

Set the following to connect to CockroachDB.

  • Server: The host name or IP address of the server.
  • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
  • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
  • User: The Cockroach DB user account used to authenticate.
  • Password: The password used to authenticate the user.

Built-in Connection String Designer

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

java -jar cdata.jdbc.cockroachdb.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:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257"

Access CockroachDB 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.cockroachdb.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 CockroachDB:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257" 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.cockroachdb.jar" conn = jaydebeapi.connect( "cdata.jdbc.cockroachdb.CockroachDBDriver", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Orders;") 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 CockroachDB and start working with your live CockroachDB data in Python. Reach out to our Support Team if you have any questions.

Ready to get started?

Download a free trial of the CockroachDB Driver to get started:

 Download Now

Learn more:

CockroachDB Icon CockroachDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with CockroachDB.

In this article

Related articles