mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -04:00
8590061ae4
This tool can be used across mysql sources.
`mysql-execute-sql` config is as below:
```
tools:
mysql_execute_sql_tool:
kind: "mysql-execute-sql"
source: my-mysql-source
description: Use this tool to execute sql.
```
The `mysql-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/mysql_execute_sql_tool/invoke
```
38 lines
1.5 KiB
Markdown
38 lines
1.5 KiB
Markdown
---
|
|
title: "mysql-execute-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "mysql-execute-sql" tool executes a SQL statement against a MySQL
|
|
database.
|
|
---
|
|
|
|
## About
|
|
|
|
A `mysql-execute-sql` tool executes a SQL statement against a MySQL
|
|
database. It's compatible with any of the following sources:
|
|
|
|
- [cloud-sql-mysql](../sources/cloud-sql-mysql.md)
|
|
- [mysql](../sources/mysql.md)
|
|
|
|
`mysql-execute-sql` takes one input parameter `sql` and run the sql
|
|
statement against the `source`.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
tools:
|
|
execute_sql_tool:
|
|
kind: mysql-execute-sql
|
|
source: my-mysql-instance
|
|
description: Use this tool to execute sql statement.
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
|
| kind | string | true | Must be "mysql-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. |
|