mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-06 21:24:58 -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>
55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
---
|
|
title: "postgres-database-overview"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
The "postgres-database-overview" fetches the current state of the PostgreSQL server.
|
|
aliases:
|
|
- /resources/tools/postgres-database-overview
|
|
---
|
|
|
|
## About
|
|
|
|
The `postgres-database-overview` fetches the current state of the PostgreSQL
|
|
server. It's compatible with any of the following sources:
|
|
|
|
- [alloydb-postgres](../../sources/alloydb-pg.md)
|
|
- [cloud-sql-postgres](../../sources/cloud-sql-pg.md)
|
|
- [postgres](../../sources/postgres.md)
|
|
|
|
`postgres-database-overview` fetches the current state of the PostgreSQL server
|
|
This tool does not take any input parameters.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: database_overview
|
|
type: postgres-database-overview
|
|
source: cloudsql-pg-source
|
|
description: |
|
|
fetches the current state of the PostgreSQL server. It returns the postgres version, whether it's a replica, uptime duration, maximum connection limit, number of current connections, number of active connections and the percentage of connections in use.
|
|
```
|
|
|
|
The response is a JSON object with the following elements:
|
|
|
|
```json
|
|
{
|
|
"pg_version": "PostgreSQL server version string",
|
|
"is_replica": "boolean indicating if the instance is in recovery mode",
|
|
"uptime": "interval string representing the total server uptime",
|
|
"max_connections": "integer maximum number of allowed connections",
|
|
"current_connections": "integer number of current connections",
|
|
"active_connections": "integer number of currently active connections",
|
|
"pct_connections_used": "float percentage of max_connections currently in use"
|
|
}
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:--------:|:------------:|------------------------------------------------------|
|
|
| type | string | true | Must be "postgres-database-overview". |
|
|
| source | string | true | Name of the source the SQL should execute on. |
|
|
| description | string | false | Description of the tool that is passed to the agent. |
|