mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-11 23:55:07 -05:00
293c1d6889
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
136 lines
5.4 KiB
Markdown
136 lines
5.4 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.
|
|
|
|
- [`postgres-list-query-stats`](../tools/postgres/postgres-list-query-stats.md)
|
|
List query statistics in a PostgreSQL database.
|
|
|
|
- [`postgres-get-column-cardinality`](../tools/postgres/postgres-get-column-cardinality.md)
|
|
List cardinality of columns in a table in a PostgreSQL database.
|
|
|
|
- [`postgres-list-table-stats`](../tools/postgres/postgres-list-table-stats.md)
|
|
List statistics of a table in a PostgreSQL database.
|
|
|
|
- [`postgres-list-publication-tables`](../tools/postgres/postgres-list-publication-tables.md)
|
|
List publication tables in a PostgreSQL database.
|
|
|
|
- [`postgres-list-tablespaces`](../tools/postgres/postgres-list-tablespaces.md)
|
|
List tablespaces in a PostgreSQL database.
|
|
|
|
- [`postgres-list-pg-settings`](../tools/postgres/postgres-list-pg-settings.md)
|
|
List configuration parameters for the PostgreSQL server.
|
|
|
|
- [`postgres-list-database-stats`](../tools/postgres/postgres-list-database-stats.md)
|
|
Lists the key performance and activity statistics for each database in the postgreSQL
|
|
server.
|
|
|
|
- [`postgres-list-roles`](../tools/postgres/postgres-list-roles.md)
|
|
Lists all the user-created roles in PostgreSQL database.
|
|
|
|
- [`postgres-list-stored-procedure`](../tools/postgres/postgres-list-stored-procedure.md)
|
|
Lists all the stored procedure in 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
|
|
kind: sources
|
|
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. |
|