genai-toolbox/docs/en/resources/tools/bigquery/bigquery-execute-sql.md

title, type, weight, description, aliases

title	type	weight	description	aliases
bigquery-execute-sql	docs	1	A "bigquery-execute-sql" tool executes a SQL statement against BigQuery.	/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

bigquery-execute-sql accepts the following parameters:

• sql (required): The GoogleSQL statement to execute.
• dry_run (optional): If set to true, the query is validated but not run, returning information about the execution instead. Defaults to false.

The tool's behavior is influenced by the allowedDatasets restriction on the bigquery source:

• Without allowedDatasets restriction: The tool can execute any valid GoogleSQL query.
• With allowedDatasets restriction: Before execution, the tool performs a dry run to analyze the query. It will reject the query if it attempts to access any table outside the allowed datasets list. To enforce this restriction, the following operations are also disallowed:
  • Dataset-level operations (e.g., CREATE SCHEMA, ALTER SCHEMA).
  • Unanalyzable operations where the accessed tables cannot be determined statically (e.g., EXECUTE IMMEDIATE, CREATE PROCEDURE, CALL).

Example

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.