mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-12 08:05:06 -05:00
293c1d6889
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
117 lines
4.7 KiB
Markdown
117 lines
4.7 KiB
Markdown
---
|
|
title: "bigquery-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "bigquery-sql" tool executes a pre-defined SQL statement.
|
|
aliases:
|
|
- /resources/tools/bigquery-sql
|
|
---
|
|
|
|
## About
|
|
|
|
A `bigquery-sql` tool executes a pre-defined SQL statement. It's compatible with
|
|
the following sources:
|
|
|
|
- [bigquery](../../sources/bigquery.md)
|
|
|
|
The behavior of this tool is influenced by the `writeMode` setting on its
|
|
`bigquery` source:
|
|
|
|
- **`allowed` (default) and `blocked`:** These modes do not impose any
|
|
restrictions on the `bigquery-sql` tool. The pre-defined SQL statement will be
|
|
executed as-is.
|
|
- **`protected`:** This mode enables session-based execution. The tool will
|
|
operate within the same BigQuery session as other tools using the same source,
|
|
allowing it to interact with temporary resources like `TEMP` tables created
|
|
within that session.
|
|
|
|
### GoogleSQL
|
|
|
|
BigQuery uses [GoogleSQL][bigquery-googlesql] for querying data. The integration
|
|
with Toolbox supports this dialect. The specified SQL statement is executed, and
|
|
parameters can be inserted into the query. BigQuery supports both named parameters
|
|
(e.g., `@name`) and positional parameters (`?`), but they cannot be mixed in the
|
|
same query.
|
|
|
|
[bigquery-googlesql]:
|
|
https://cloud.google.com/bigquery/docs/reference/standard-sql/
|
|
|
|
## Example
|
|
|
|
> **Note:** This tool uses [parameterized
|
|
> queries](https://cloud.google.com/bigquery/docs/parameterized-queries) to
|
|
> prevent SQL injections. Query parameters can be used as substitutes for
|
|
> arbitrary expressions. Parameters cannot be used as substitutes for
|
|
> identifiers, column names, table names, or other parts of the query.
|
|
|
|
```yaml
|
|
# Example: Querying a user table in BigQuery
|
|
kind: tools
|
|
name: search_users_bq
|
|
type: bigquery-sql
|
|
source: my-bigquery-source
|
|
statement: |
|
|
SELECT
|
|
id,
|
|
name,
|
|
email
|
|
FROM
|
|
`my-project.my-dataset.users`
|
|
WHERE
|
|
id = @id OR email = @email;
|
|
description: |
|
|
Use this tool to get information for a specific user.
|
|
Takes an id number or a name and returns info on the user.
|
|
|
|
Example:
|
|
{{
|
|
"id": 123,
|
|
"name": "Alice",
|
|
}}
|
|
parameters:
|
|
- name: id
|
|
type: integer
|
|
description: User ID
|
|
- name: email
|
|
type: string
|
|
description: Email address of the user
|
|
```
|
|
|
|
### Example with Template Parameters
|
|
|
|
> **Note:** This tool allows direct modifications to the SQL statement,
|
|
> including identifiers, column names, and table names. **This makes it more
|
|
> vulnerable to SQL injections**. Using basic parameters only (see above) is
|
|
> recommended for performance and safety reasons. For more details, please check
|
|
> [templateParameters](../#template-parameters).
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: list_table
|
|
type: bigquery-sql
|
|
source: my-bigquery-source
|
|
statement: |
|
|
SELECT * FROM {{.tableName}};
|
|
description: |
|
|
Use this tool to list all information from a specific table.
|
|
Example:
|
|
{{
|
|
"tableName": "flights",
|
|
}}
|
|
templateParameters:
|
|
- name: tableName
|
|
type: string
|
|
description: Table to select from
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|--------------------|:---------------------------------------------:|:------------:|-----------------------------------------------------------------------------------------------------------------------------------------|
|
|
| type | string | true | Must be "bigquery-sql". |
|
|
| source | string | true | Name of the source the GoogleSQL should execute on. |
|
|
| description | string | true | Description of the tool that is passed to the LLM. |
|
|
| statement | string | true | The GoogleSQL statement to execute. |
|
|
| parameters | [parameters](../#specifying-parameters) | false | List of [parameters](../#specifying-parameters) that will be inserted into the SQL statement. |
|
|
| templateParameters | [templateParameters](../#template-parameters) | false | List of [templateParameters](../#template-parameters) that will be inserted into the SQL statement before executing prepared statement. | |