Ready to get started?

Learn more about the CData ODBC Driver for Couchbase or download a free trial:

Download Now

Using the CData ODBC Driver for Couchbase in PyCharm

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

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

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 connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.

Below is the syntax for a DSN:

[CData Couchbase Source] Driver = CData ODBC Driver for Couchbase Description = My Description User = myuseraccount Password = mypassword Server = http://mycouchbaseserver

Execute SQL to Couchbase

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 Couchbase};User = myuseraccount;Password = mypassword;Server = http://mycouchbaseserver;') cursor = cnxn.cursor() cursor.execute("SELECT FirstName, TotalDue FROM Customer WHERE FirstName = 'Bob'") rows = cursor.fetchall() for row in rows: print(row.FirstName, row.TotalDue)

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