mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -04:00
5abad5d56c
Adds the following tools for Postgre (1) long_running_transactions - reports transactions that exceed a configured duration threshold. (2) list_locks - lists active locks in the database, including the associated process, lock type, relation, mode, and the query holding or waiting on the lock. (3) replication_stats - reports replication-related metrics for WAL streaming replicas, including lag sizes presented in human-readable form. <img width="3020" height="1420" alt="image" src="https://github.com/user-attachments/assets/e7d70063-b90c-4464-90ec-1bd810c02cac" /> <img width="3036" height="1374" alt="image" src="https://github.com/user-attachments/assets/f7cf584b-ae01-455c-9c9c-acca3166a549" /> <img width="2682" height="868" alt="image" src="https://github.com/user-attachments/assets/dd10646c-4521-4d8f-a111-760d6eb01249" /> ## PR Checklist - [Y] Make sure you reviewed [CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md) - [Y] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [Y] Ensure the tests and linter pass - [Y] Code coverage does not decrease (if any source code was changed) - [Y] Appropriate docs were updated (if necessary) - [Y] Make sure to add `!` if this involve a breaking change 🛠️ Fixes #1691 #1715 --------- Co-authored-by: Wenxin Du <117315983+duwenxin99@users.noreply.github.com>
108 lines
4.2 KiB
Markdown
108 lines
4.2 KiB
Markdown
---
|
|
title: "PostgreSQL"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
PostgreSQL is a powerful, open source object-relational database.
|
|
|
|
---
|
|
|
|
## About
|
|
|
|
[PostgreSQL][pg-docs] 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.
|
|
|
|
[pg-docs]: https://www.postgresql.org/
|
|
|
|
## Available Tools
|
|
|
|
- [`postgres-sql`](../tools/postgres/postgres-sql.md)
|
|
Execute SQL queries as prepared statements in PostgreSQL.
|
|
|
|
- [`postgres-execute-sql`](../tools/postgres/postgres-execute-sql.md)
|
|
Run parameterized SQL statements in PostgreSQL.
|
|
|
|
- [`postgres-list-tables`](../tools/postgres/postgres-list-tables.md)
|
|
List tables in a PostgreSQL database.
|
|
|
|
- [`postgres-list-active-queries`](../tools/postgres/postgres-list-active-queries.md)
|
|
List active queries in a PostgreSQL database.
|
|
|
|
- [`postgres-list-available-extensions`](../tools/postgres/postgres-list-available-extensions.md)
|
|
List available extensions for installation in a PostgreSQL database.
|
|
|
|
- [`postgres-list-installed-extensions`](../tools/postgres/postgres-list-installed-extensions.md)
|
|
List installed extensions in a PostgreSQL database.
|
|
|
|
- [`postgres-list-views`](../tools/postgres/postgres-list-views.md)
|
|
List views in a PostgreSQL database.
|
|
|
|
- [`postgres-list-schemas`](../tools/postgres/postgres-list-views.md)
|
|
List schemas in a PostgreSQL database.
|
|
|
|
- [`postgres-database-overview`](../tools/postgres/postgres-database-overview.md)
|
|
Fetches the current state of the PostgreSQL server.
|
|
|
|
- [`postgres-list-triggers`](../tools/postgres/postgres-list-triggers.md)
|
|
List triggers in a PostgreSQL database.
|
|
|
|
- [`postgres-list-indexes`](../tools/postgres/postgres-list-indexes.md)
|
|
List available user indexes in a PostgreSQL database.
|
|
|
|
- [`postgres-list-sequences`](../tools/postgres/postgres-list-sequences.md)
|
|
List sequences in a PostgreSQL database.
|
|
|
|
- [`postgres-long-running-transactions`](../tools/postgres/postgres-long-running-transactions.md)
|
|
List long running transactions in a PostgreSQL database.
|
|
|
|
- [`postgres-list-locks`](../tools/postgres/postgres-list-locks.md)
|
|
List lock stats in a PostgreSQL database.
|
|
|
|
- [`postgres-replication-stats`](../tools/postgres/postgres-replication-stats.md)
|
|
List replication stats in a PostgreSQL database.
|
|
|
|
### Pre-built Configurations
|
|
|
|
- [PostgreSQL using MCP](https://googleapis.github.io/genai-toolbox/how-to/connect-ide/postgres_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][pg-users] to login to the database with.
|
|
|
|
[pg-users]: https://www.postgresql.org/docs/current/sql-createuser.html
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
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. |
|