Back to Genai Toolbox

PostgreSQL Source

docs/en/integrations/postgres/source.md

1.1.02.4 KB
Original Source

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

yaml
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

fieldtyperequireddescription
typestringtrueMust be "postgres".
hoststringtrueIP address to connect to (e.g. "127.0.0.1")
portstringtruePort to connect to (e.g. "5432")
databasestringtrueName of the Postgres database to connect to (e.g. "my_db").
userstringtrueName of the Postgres user to connect as (e.g. "my-pg-user").
passwordstringtruePassword of the Postgres user (e.g. "my-password").
queryParamsmap[string]stringfalseRaw query to be added to the db connection string.
queryExecModestringfalsepgx 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.