Python Connect to PostgreSQL Database

PostgreSQL is an open-source relational database system. In this tutorial, we’ll explore all the steps you need to connect to PostgreSQL database from Python. From setting up a PostgreSQL database to executing queries using Python, we’ll cover it all. By the end, you’ll have a solid foundation for seamlessly interacting with PostgreSQL databases in your Python projects.

Also Read:
How to Connect MySQL DB from Python
How to Connect Mongo DB from Python

How to Connect to PostgreSQL Database in Python

Below are the steps you can follow to connect PostgreSQL and run SQL queries from your Python code.

Install Required Libraries

Before diving into PostgreSQL-Python connectivity, ensure you have the necessary libraries installed. Use the following commands:

pip install psycopg2

This installs the psycopg2 library, a PostgreSQL adapter for Python. Now, let’s delve into the details.

Create a PostgreSQL Database

Assuming you have PostgreSQL installed on your machine, let’s create a database and a table for demonstration purposes. Open your PostgreSQL shell and run the following SQL commands:

CREATE DATABASE tutorialdb;

Now, connect to the newly created database:

\c tutorialdb;

You can run the above command in the command-line interface (CLI) to connect to a specific DB like tutorialdb. Let’s now create a sample table:

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    username VARCHAR NOT NULL,
    email VARCHAR NOT NULL
);

This sets up a basic database structure that we’ll interact with using Python.

Connect to PostgreSQL from Python

Now, let’s jump into Python and create a connection to our database. Use the following script as a starting point:

import psycopg2

# Start the connection
conn = psycopg2.connect(
    database="tutorialdb",
    user="srv_username",
    password="srv_password",
    host="srv_host",
    port="srv_port"
)

# Create a cursor object
cursor = conn.cursor()

# Run operations...

# Closing the cursor and connection
cursor.close()
conn.close()

Replace placeholders with your PostgreSQL credentials. This script initiates a connection and creates a cursor, essential for running the SQL commands

Set Concurrent User Connections

To allow multiple users or connections, use connection pooling to manage and reuse DB connections.

from psycopg2 import pool

# Create a conn pool
conn_pool = pool.SimpleConnectionPool(
    1,  # Min no of conn
    5,  # Max no of conn
    database="tutorialdb",
    user="srv_username",
    password="srv_password",
    host="srv_host",
    port="srv_port"
)

# Make a conn from the pool
conn = conn_pool.getconn()

# ... Run operations ...

# Free the conn back to the pool
conn_pool.putconn(conn)

Run SQL Queries from Python

With the connection established, let’s execute some basic queries. For instance, inserting data into the ‘users’ table:

# Example: Inserting data
cursor.execute("INSERT INTO users (username, email) VALUES (%s, %s)", ("akbar_malik", "akbar@example.com"))

# Committing the changes
conn.commit()

This inserts a new user into the ‘users’ table. Always remember to commit changes to persist them in the database.

Now, let’s fetch data:

# Example: Fetching data
cursor.execute("SELECT * FROM users")

# Fetch all rows
rows = cursor.fetchall()

# Displaying the results
for row in rows:
    print(row)

This retrieves all rows from the ‘users’ table and prints them.

Handle Exceptions in Python

Python Exception handling is crucial when dealing with databases. Wrap your database operations in try-except blocks to gracefully handle errors:

try:
    # Database operations here...

except psycopg2.Error as e:
    print(f"Error: {e}")

finally:
    # Cleanup operations (closing cursor and connection)
    cursor.close()
    conn.close()

This ensures that even if an error occurs, the connection and cursor are properly closed, preventing potential issues.

Commit and Rollback from Python

psycopg2 supports transactions. It allows you to group multiple SQL statements into a single atomic operation. Use the commit() method to apply changes or the rollback() method to discard them.

try:
    # Start a transaction
    conn = psycopg2.connect(database="tutorialdb", user="srv_username", password="srv_password", host="srv_host", port="srv_port")
    cursor = conn.cursor()

    # Run SQL commands within the transaction
    cursor.execute("INSERT INTO users (username, email) VALUES (%s, %s)", ("rihana_julfi", "rihana@example.com"))

    # Commit the transaction
    conn.commit()

except Exception as e:
    # Rollback the transaction in case of an error
    conn.rollback()
    print(f"Error: {e}")

finally:
    # Close the cursor and conn
    cursor.close()
    conn.close()

Using Python Context Managers

Python’s context managers, facilitated by the with statement, simplify resource management. Let’s modify our connection script to use a context manager:

import psycopg2

# Establishing the connection using a context manager
with psycopg2.connect(
        database="tutorialdb",
        user="srv_username",
        password="srv_password",
        host="srv_host",
        port="srv_port"
) as conn:
    # Creating a cursor within the context manager
    with conn.cursor() as cursor:
        # Performing operations...

# No need to explicitly close the connection and cursor; the context manager handles it

This ensures proper resource cleanup without the need for explicit close() calls.

Parameterized Queries for Security

To prevent SQL injection attacks, always use parameterized queries. Here’s an example:

# Example: Parameterized query
username = "salma_bano"
email = "salmab@example.com"

cursor.execute("INSERT INTO users (username, email) VALUES (%s, %s)", (username, email))

This approach ensures that user inputs are treated as data and not executable code.

Fetch Records from PostgreSQL Tables

Let’s refine our data fetching example to retrieve specific records based on a condition:

# Example: Fetching specific records
cursor.execute("SELECT * FROM users WHERE username = %s", ("abu_asim",))

# Fetch the first matching row
row = cursor.fetchone()

# Displaying the result
print(row)

This fetches the first row where the username is “abu_asim.”

Conclusion – Python to Connect with PostgreSQL

In this tutorial, we covered the essential steps to connect PostgreSQL with Python. From installation to executing queries and handling exceptions, you now have a solid understanding of integrating these two powerful tools. As you continue to explore this synergy, consider exploring advanced topics such as ORM (Object-Relational Mapping) libraries to further enhance your Python-PostgreSQL experience.

Happy Coding,
TechBeamers.