mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-13 00:25:10 -05:00
d65747a2dc
This tool can be used across spanner sources.
`spanner-execute-sql` config is as below:
```
tools:
spanner_execute_sql_tool:
kind: "spanner-execute-sql"
source: my-spanner-source
description: Use this tool to execute sql.
```
The `spanner-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/spanner_execute_sql_tool/invoke
```
---------
Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com>
38 lines
1.6 KiB
Markdown
38 lines
1.6 KiB
Markdown
---
|
|
title: "spanner-execute-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "spanner-execute-sql" tool executes a SQL statement against a Spanner
|
|
database.
|
|
---
|
|
|
|
## About
|
|
|
|
A `spanner-execute-sql` tool executes a SQL statement against a Spanner
|
|
database. It's compatible with any of the following sources:
|
|
|
|
- [spanner](../sources/spanner.md)
|
|
|
|
`spanner-execute-sql` takes one input parameter `sql` and run the sql
|
|
statement against the `source`.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
tools:
|
|
execute_sql_tool:
|
|
kind: spanner-execute-sql
|
|
source: my-spanner-instance
|
|
description: Use this tool to execute sql statement.
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
|
| kind | string | true | Must be "spanner-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. |
|
|
| readOnly | bool | false | When set to `true`, the `statement` is run as a read-only transaction. Default: `false`. |
|