mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-13 08:35:15 -05:00
1cac9b5b37
Add optional `dry_run` parameter to bigquery-execute-sql, which defaults to `false`. When the `dry_run` parameter is set to `true`, the tool returns the metadata from the dry run instead of executing the query. Fixes #703 --------- Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
---
|
|
title: "bigquery-execute-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "bigquery-execute-sql" tool executes a SQL statement against BigQuery.
|
|
aliases:
|
|
- /resources/tools/bigquery-execute-sql
|
|
---
|
|
|
|
## About
|
|
|
|
A `bigquery-execute-sql` tool executes a SQL statement against BigQuery.
|
|
It's compatible with the following sources:
|
|
|
|
- [bigquery](../../sources/bigquery.md)
|
|
|
|
`bigquery-execute-sql` takes a required `sql` input parameter and runs the SQL
|
|
statement against the configured `source`. It also supports an optional `dry_run`
|
|
parameter to validate a query without executing it.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
tools:
|
|
execute_sql_tool:
|
|
kind: bigquery-execute-sql
|
|
source: my-bigquery-source
|
|
description: Use this tool to execute sql statement.
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:------------------------------------------:|:------------:|--------------------------------------------------------------------------------------------------|
|
|
| kind | string | true | Must be "bigquery-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. |
|