mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-12 08:05:06 -05:00
11ea7bc584
This tool can be used across all postgres sources.
`postgres-execute-sql` config is as below:
```
tools:
postgres_execute_sql_tool:
kind: "postgres-execute-sql"
source: my-alloydb-source // or any other sources that is compatible with this tool
description: Use this tool to execute sql.
```
The `postgres-execute-sql` tool takes one parameter. Example request as
follow:
```
curl -X POST -H "Content-Type: application/json" -d '{"sql": "SELECT 1"}' http://127.0.0.1:5000/api/tool/postgres_execute_sql_tool/invoke
```
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
---
|
|
title: "postgres-execute-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "postgres-execute-sql" tool executes a SQL statement against a Postgres
|
|
database.
|
|
---
|
|
|
|
## 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`.
|
|
|
|
## 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. |
|