PostgreSQL

https://www.postgresql.org/

PostgreSQL is an advanced open-source relational database.

Installation

Required packages: psycopg2

Connection String

postgresql://{username}:{password}@{host}:{port}/{database}

Parameter	Description
username	Database username
password	Database password
host	For localhost: localhost or 127.0.0.1. For AWS: endpoint URL
port	Default 5432
database	Database name

Default port: 5432

Connection Examples

Basic connection

postgresql://{username}:{password}@{host}:{port}/{database}

With SSL required

postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require

Supported Features

JOINsSubqueriesDynamic SchemaCatalog SupportDynamic CatalogSSH TunnelingQuery CancellationFile UploadUser ImpersonationCost EstimationSQL Validation

Feature Score: 104/201

Time Grains

Common Time Grains:

SECONDMINUTEHOURDAYWEEKMONTHQUARTERYEAR

Extended Time Grains:

FIVE_SECONDSTHIRTY_SECONDSFIVE_MINUTESTEN_MINUTESFIFTEEN_MINUTESTHIRTY_MINUTESHALF_HOURSIX_HOURSWEEK_STARTING_SUNDAYWEEK_STARTING_MONDAYWEEK_ENDING_SATURDAYWEEK_ENDING_SUNDAYQUARTER_YEAR

Troubleshooting

Common error messages you may encounter when connecting to or querying PostgreSQL, along with their causes and solutions.

Authentication3 errors

Connection4 errors

Query2 errors

Compatible Databases

The following databases are compatible with the PostgreSQL driver:

Hologres

Alibaba Cloud real-time interactive analytics service, fully compatible with PostgreSQL 11.

postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}

Parameters:

Parameter	Description
username	AccessKey ID of your Alibaba Cloud account
password	AccessKey secret of your Alibaba Cloud account
host	Public endpoint of the Hologres instance
port	Port number of the Hologres instance
database	Name of the Hologres database

TimescaleDB

Open-source relational database for time-series and analytics, built on PostgreSQL.

postgresql://{username}:{password}@{host}:{port}/{database}

psycopg2 comes bundled with Superset Docker images.

YugabyteDB

Distributed SQL database built on top of PostgreSQL.

postgresql://{username}:{password}@{host}:{port}/{database}

psycopg2 comes bundled with Superset Docker images.

Amazon Aurora PostgreSQL

Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational database with up to 5x the throughput of standard PostgreSQL.

postgresql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}&region_name={region_name}

Parameters:

Parameter	Description
aws_access_id	AWS Access Key ID
aws_secret_access_key	AWS Secret Access Key
database_name	Database name
aurora_cluster_arn	Aurora cluster ARN
secret_arn	Secrets Manager ARN for credentials
region_name	AWS region (e.g., us-east-1)

Uses the Data API for serverless access. Standard PostgreSQL connections also work with psycopg2.

Notes

The psycopg2 library comes bundled with Superset Docker images.

Resources

Official Documentation

SQLAlchemy Dialect Documentation

Help improve this documentation by editing the engine spec:

Edit postgres.py