mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-05 20:54:56 -05:00
a1b60100c2
Group tools of the same type into the same folder so that they are more discoverable and our tools are more organized as the number grows.
44 lines
1.8 KiB
Markdown
44 lines
1.8 KiB
Markdown
---
|
|
title: "postgres-execute-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "postgres-execute-sql" tool executes a SQL statement against a Postgres
|
|
database.
|
|
aliases:
|
|
- /resources/tools/postgres-execute-sql
|
|
---
|
|
|
|
## About
|
|
|
|
A `postgres-execute-sql` tool executes a SQL statement against a Postgres
|
|
database. 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-execute-sql` takes one input parameter `sql` and run the sql
|
|
statement against the `source`.
|
|
|
|
> **Note:** This tool is intended for developer assistant workflows with
|
|
> human-in-the-loop and shouldn't be used for production agents.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
tools:
|
|
execute_sql_tool:
|
|
kind: postgres-execute-sql
|
|
source: my-pg-instance
|
|
description: Use this tool to execute sql statement.
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
|
| kind | string | true | Must be "postgres-execute-sql". |
|
|
| source | string | true | Name of the source the SQL should execute on. |
|
|
| description | string | true | Description of the tool that is passed to the LLM. |
|