Using the CData ODBC Driver for CouchDB in PyCharm

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

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:

• Url: The Url of your instance. For example: http://localhost:5984
• User The Apache CouchDB user account used to authenticate.
• Password The Apache CouchDB password associated with the authenticating user.

Below is the syntax for a DSN:

[CData ApacheCouchDB Source]
Driver = CData ODBC Driver for CouchDB
Description = My Description
Url = http://localhost:5984
User = abc123
Password = abcdef

Execute SQL to CouchDB

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 ApacheCouchDB};Url = http://localhost:5984;User = abc123;Password = abcdef;')
cursor = cnxn.cursor()
cursor.execute("SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'")
rows = cursor.fetchall()
for row in rows:
 print(row.MovieRuntime, row.MovieRating)

After connecting to CouchDB in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to CouchDB data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].