mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-05-02 03:00:36 -04:00
6fc49826d4
1.Added oceanbase Source and Tool 2.Add tests related to OceanBase 3.Add the documentation for Oceanbase Close #894 --------- Co-authored-by: Wenxin Du <117315983+duwenxin99@users.noreply.github.com> Co-authored-by: duwenxin <duwenxin@google.com>
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
---
|
|
title: "oceanbase-execute-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
An "oceanbase-execute-sql" tool executes a SQL statement against an OceanBase database.
|
|
aliases:
|
|
- /resources/tools/oceanbase-execute-sql
|
|
---
|
|
|
|
## About
|
|
|
|
An `oceanbase-execute-sql` tool executes a SQL statement against an OceanBase database. It's compatible with the following source:
|
|
|
|
- [oceanbase](../sources/oceanbase.md)
|
|
|
|
`oceanbase-execute-sql` takes one input parameter `sql` and runs 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
|
|
|
|
```yaml
|
|
tools:
|
|
execute_sql_tool:
|
|
kind: oceanbase-execute-sql
|
|
source: my-oceanbase-instance
|
|
description: Use this tool to execute sql statement.
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:----------:|:------------:|--------------------------------------------------------------------------------------------------|
|
|
| kind | string | true | Must be "oceanbase-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. | |