Skip to content

Adapters

PostgreSQL

PostgreSQL adapter configuration for SQLBuild.

PostgreSQL requires the optional psycopg dependency:

pip install 'sqlbuild[postgres]'
# or
uv pip install 'sqlbuild[postgres]'
adapter = "postgres"
default_target = "dev"
[connections.postgres]
host = "localhost"
port = 5432
user = "my_user"
password = "my_password"
dbname = "my_database"
[targets.dev]
connection = "postgres"
database = "my_database"
schema = "analytics_dev"
Field Description
host PostgreSQL server hostname (default: localhost)
port PostgreSQL server port (default: 5432)
user Database user
password Database password
dbname Database name

Connection fields are passed to psycopg.connect(). See the psycopg documentation for all available options. The target remains authoritative for database and schema qualification.

adapter = "postgres"
[connections.postgres]
host = "localhost"
user = "my_user"
password = "${ENV:PG_PASSWORD}"
dbname = "analytics"
[targets.prod]
connection = "postgres"
database = "analytics"
schema = "prod"
[targets.dev]
connection = "postgres"
database = "analytics"
schema = "dev"