Back to Genai Toolbox

spanner-execute-sql

docs/en/integrations/spanner/tools/spanner-execute-sql.md

1.1.01.3 KB
Original Source

About

A spanner-execute-sql tool executes a SQL statement against a Spanner database.

spanner-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.

Compatible Sources

{{< compatible-sources >}}

Example

yaml
kind: tool
name: execute_sql_tool
type: spanner-execute-sql
source: my-spanner-instance
description: Use this tool to execute sql statement.

Reference

fieldtyperequireddescription
typestringtrueMust be "spanner-execute-sql".
sourcestringtrueName of the source the SQL should execute on.
descriptionstringtrueDescription of the tool that is passed to the LLM.
readOnlyboolfalseWhen set to true, the statement is run as a read-only transaction. Default: false.