docs/en/integrations/bigquery/tools/bigquery-execute-sql.md
A bigquery-execute-sql tool executes a SQL statement against 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 behavior of this tool is influenced by the writeMode setting on its
bigquery source:
allowed (default): All SQL statements are permitted.blocked: Only SELECT statements are allowed. Any other type of
statement (e.g., INSERT, UPDATE, CREATE) will be rejected.protected: This mode enables session-based execution. SELECT
statements can be used on all tables, while write operations are allowed only
for the session's temporary dataset (e.g., CREATE TEMP TABLE ...). This
prevents modifications to permanent datasets while allowing stateful,
multi-step operations within a secure session.The tool's behavior is influenced by the allowedDatasets restriction on the
bigquery source. Similar to writeMode, this setting provides an additional
layer of security by controlling which datasets can be accessed:
allowedDatasets restriction: The tool can execute any valid
GoogleSQL query.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:
CREATE SCHEMA, ALTER SCHEMA).EXECUTE IMMEDIATE, CREATE PROCEDURE, CALL).Note: This tool is intended for developer assistant workflows with human-in-the-loop and shouldn't be used for production agents.
{{< compatible-sources >}}
kind: tool
name: execute_sql_tool
type: bigquery-execute-sql
source: my-bigquery-source
description: Use this tool to execute sql statement.
| field | type | required | description |
|---|---|---|---|
| type | 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. |