genai-toolbox/docs/en/resources/sources/postgres.md

title, type, weight, description

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

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

• postgres-sql Execute SQL queries as prepared statements in PostgreSQL.

• postgres-execute-sql Run parameterized SQL statements in PostgreSQL.

• postgres-list-tables List tables in a PostgreSQL database.

• postgres-list-active-queries List active queries in a PostgreSQL database.

• postgres-list-available-extensions List available extensions for installation in a PostgreSQL database.

• postgres-list-installed-extensions List installed extensions in a PostgreSQL database.

• postgres-list-views List views in a PostgreSQL database.

• postgres-list-schemas List schemas in a PostgreSQL database.

• postgres-database-overview Fetches the current state of the PostgreSQL server.

• postgres-list-triggers List triggers in a PostgreSQL database.

• postgres-list-indexes List available user indexes in a PostgreSQL database.

• postgres-list-sequences List sequences in a PostgreSQL database.

• postgres-long-running-transactions List long running transactions in a PostgreSQL database.

• postgres-list-locks List lock stats in a PostgreSQL database.

• postgres-replication-stats List replication stats in a PostgreSQL database.

• postgres-list-query-stats List query statistics in a PostgreSQL database.

• postgres-get-column-cardinality List cardinality of columns in a table in a PostgreSQL database.

• postgres-list-table-stats List statistics of a table in a PostgreSQL database.

• postgres-list-publication-tables List publication tables in a PostgreSQL database.

• postgres-list-tablespaces List tablespaces in a PostgreSQL database.

• postgres-list-pg-settings List configuration parameters for the PostgreSQL server.

• postgres-list-database-stats Lists the key performance and activity statistics for each database in the postgreSQL server.

• postgres-list-roles Lists all the user-created roles in PostgreSQL database..

Pre-built Configurations

• PostgreSQL using MCP Connect your IDE to PostgreSQL using Toolbox.

Requirements

Database User

This source only uses standard authentication. You will need to create a PostgreSQL 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: ${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
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").
queryParams	map[string]string	false	Raw query to be added to the db connection string.