Using the CData ODBC Driver for PostgreSQL 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 PostgreSQL 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 PostgreSQL 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.

👁 Image

Connect to PostgreSQL

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 PostgreSQL, set the Server, Port (the default port is 5432), and Database connection properties and set the User and Password you wish to use to authenticate to the server. If the Database property is not specified, the data provider connects to the user's default database.

SSH Connectivity for PostgreSQL

You can use SSH (Secure Shell) to authenticate with PostgreSQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

SSH Connections to PostgreSQL in Password Auth Mode

To connect to PostgreSQL via SSH in Password Auth mode, set the following connection properties:

• User: PostgreSQL User name
• Password: PostgreSQL Password
• Database: PostgreSQL database name
• Server: PostgreSQL Server name
• Port: PostgreSQL port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Password"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHPassword: SSH Password

SSH Connections to PostgreSQL in Public Key Auth Mode

To connect to PostgreSQL via SSH in Password Auth mode, set the following connection properties:

• User: PostgreSQL User name
• Password: PostgreSQL Password
• Database: PostgreSQL database name
• Server: PostgreSQL Server name
• Port: PostgreSQL port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Public_Key"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHClientCret: the path for the public key certificate file

Below is the syntax for a DSN:

[CData PostgreSQL Source]
Driver = CData ODBC Driver for PostgreSQL
Description = My Description
User = postgres
Password = admin
Database = postgres
Server = 127.0.0.1
Port = 5432

Execute SQL to PostgreSQL

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 PostgreSQL};User = postgres;Password = admin;Database = postgres;Server = 127.0.0.1;Port = 5432;')
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 PostgreSQL in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to PostgreSQL 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].