genai-toolbox/docs/en/resources/tools/postgres/postgres-execute-sql.md

title, type, weight, description, aliases

title	type	weight	description	aliases
postgres-execute-sql	docs	1	A "postgres-execute-sql" tool executes a SQL statement against a Postgres database.	/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
• cloud-sql-postgres
• postgres

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

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.