Back to Genai Toolbox

tidb-execute-sql

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

1.1.01.0 KB
Original Source

About

A tidb-execute-sql tool executes a SQL statement against a TiDB database.

tidb-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: tidb-execute-sql
source: my-tidb-instance
description: Use this tool to execute sql statement.

Reference

fieldtyperequireddescription
typestringtrueMust be "tidb-execute-sql".
sourcestringtrueName of the source the SQL should execute on.
descriptionstringtrueDescription of the tool that is passed to the LLM.