Files
wehub-resource-sync e04ed9c211
CF: Deploy Dev Docs / deploy (push) Waiting to run
Sync Labels / build (push) Waiting to run
tests / unit tests (macos-latest) (push) Waiting to run
tests / unit tests (ubuntu-latest) (push) Waiting to run
tests / unit tests (windows-latest) (push) Waiting to run
chore: import upstream snapshot with attribution
2026-07-13 13:32:45 +08:00

2.7 KiB

title, linkTitle, type, weight, description, no_list
title linkTitle type weight description no_list
PostgreSQL Source Source docs 1 PostgreSQL is a powerful, open source object-relational database. true

About

PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

Available Tools

{{< list-tools >}}

Pre-built Configurations

Requirements

Database User

This source only uses standard authentication. You will need to create a PostgreSQL user to login to the database with.

Example

kind: source
name: my-pg-source
type: postgres
host: 127.0.0.1
port: 5432
database: my_db
user: ${USER_NAME}
password: ${PASSWORD}

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

Reference

field type required description
type string true Must be "postgres".
host string true IP address to connect to (e.g. "127.0.0.1")
port string true Port to connect to (e.g. "5432")
database string true Name of the Postgres database to connect to (e.g. "my_db").
user string true Name of the Postgres user to connect as (e.g. "my-pg-user").
password string true Password of the Postgres user (e.g. "my-password").
queryParams map[string]string false Raw query to be added to the db connection string.
queryExecMode string false pgx query execution mode. Valid values: cache_statement (default), cache_describe, describe_exec, exec, simple_protocol. Useful with connection poolers that don't support prepared statement caching.
sqlCommenter boolean false Overrides the global --sql-commenter flag for this source. When set, it takes priority; when omitted, the global flag applies.