Files
genai-toolbox/docs/en/resources/tools/postgres-execute-sql.md
Yuan 11ea7bc584 feat: add postgres-execute-sql tool (#490)
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
```
2025-05-01 17:43:41 +00:00

1.6 KiB

title, type, weight, description
title type weight description
postgres-execute-sql docs 1 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:

postgres-execute-sql takes one input parameter sql and run the sql statement against the source.

Example

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.