Ready to get started?

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

Download Now

Using the CData ODBC Driver for Redis in PyCharm

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

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

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 connection properties to connect to a Redis instance:

  • Server: Set this to the name or address of the server your Redis instance is running on. You can specify the port in Port.
  • Password: Set this to the password used to authenticate with a password-protected Redis instance , using the Redis AUTH command.

Set UseSSL to negotiate SSL/TLS encryption when you connect.

Below is the syntax for a DSN:

[CData Redis Source] Driver = CData ODBC Driver for Redis Description = My Description Server = 127.0.0.1 Port = 6379 Password = myPassword

Execute SQL to Redis

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 Redis};Server = 127.0.0.1;Port = 6379;Password = myPassword;') cursor = cnxn.cursor() cursor.execute("SELECT City, CompanyName FROM Customers WHERE Country = 'US'") rows = cursor.fetchall() for row in rows: print(row.City, row.CompanyName)

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