We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Using the CData ODBC Driver for Redshift in PyCharm
Connect to Redshift as an ODBC data source in PyCharm using the CData ODBC Driver for Redshift.
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 Redshift 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 Redshift as well as PyCharm.
Add Pyodbc to the Project
Follow the steps below to add the pyodbc module to your project.
- Click File -> Settings to open the project settings window.
- Click Project Interpreter from the Project: YourProjectName menu.
- To add pyodbc, click the + button and enter pyodbc.
- Click Install Package to install pyodbc.
Connect to Redshift
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 to Redshift, set the following:
- Server: Set this to the host name or IP address of the cluster hosting the Database you want to connect to.
- Port: Set this to the port of the cluster.
- Database: Set this to the name of the database. Or, leave this blank to use the default database of the authenticated user.
- User: Set this to the username you want to use to authenticate to the Server.
- Password: Set this to the password you want to use to authenticate to the Server.
You can obtain the Server and Port values in the AWS Management Console:
- Open the Amazon Redshift console (http://console.aws.amazon.com/redshift).
- On the Clusters page, click the name of the cluster.
- On the Configuration tab for the cluster, copy the cluster URL from the connection strings displayed.
Below is the syntax for a DSN:
[CData Redshift Source]
Driver = CData ODBC Driver for Redshift
Description = My Description
User = admin
Password = admin
Database = dev
Server = examplecluster.my.us-west-2.redshift.amazonaws.com
Port = 5439
Execute SQL to Redshift
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 Redshift};User = admin;Password = admin;Database = dev;Server = examplecluster.my.us-west-2.redshift.amazonaws.com;Port = 5439;')
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 Redshift in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Redshift 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].