Files
genai-toolbox/docs/sources/postgres.md
Kurtis Van Gent bf85e6f2fc docs: add detailed documentation for sources (#37)
Adds more detailed documentation for sources.
2024-10-31 20:25:12 +00:00

1.6 KiB

PostgreSQL Source

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.

Requirements

Database User

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

Example

sources:
    my-pg-source:
        kind: "postgres"
        host: "127.0.0.1"
        port: "5432"
        database: "my_db"
        user: "my-user"
        password: "my-password"

Reference

field type required description
kind 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").