Using the CData ODBC Driver for CockroachDB in PyCharm

Ready to get started?

Download for a free trial:

Download Now

Learn more:

CockroachDB ODBC Driver

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

Access CockroachDB data like you would a database - read, write, and update CockroachDB NewSQLDB, etc. through a standard ODBC Driver interface.



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

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 CockroachDB 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 CockroachDB 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 CockroachDB

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.

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.

Below is the syntax for a DSN:

[CData CockroachDB Source] Driver = CData ODBC Driver for CockroachDB Description = My Description User = root Password = root Database = system Server = localhost Port = 26257

Execute SQL to CockroachDB

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 CockroachDB};User = root;Password = root;Database = system;Server = localhost;Port = 26257') cursor = cnxn.cursor() cursor.execute("SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'") rows = cursor.fetchall() for row in rows: print(row.ShipName, row.ShipCity)

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