genai-toolbox/docs/en/resources/tools/bigquery/bigquery-list-table-ids.md at 95a00e92e0383a44bcfb95e8aec45918dfd03d85

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-04-09 03:02:26 -04:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

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>

2026-01-27 16:58:43 -08:00

2.3 KiB

Raw Blame History

title, type, weight, description, aliases

title

type

weight

description

aliases

bigquery-list-table-ids

docs

A "bigquery-list-table-ids" tool returns table IDs in a given BigQuery dataset.

/resources/tools/bigquery-list-table-ids

About

A bigquery-list-table-ids tool returns table IDs in a given BigQuery dataset. It's compatible with the following sources:

bigquery

bigquery-list-table-ids accepts the following parameters:

dataset (required): Specifies the dataset from which to list table IDs.
project (optional): Defines the Google Cloud project ID. If not provided, the tool defaults to the project from the source configuration.

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

Without allowedDatasets restriction: The tool can list tables from any dataset specified by the dataset and project parameters.
With allowedDatasets restriction: Before listing tables, the tool verifies that the requested dataset is in the allowed list. If it is not, the request is denied. If only one dataset is specified in the allowedDatasets list, it will be used as the default value for the dataset parameter.

Example

kind: tools
name: bigquery_list_table_ids
type: bigquery-list-table-ids
source: my-bigquery-source
description: Use this tool to get table metadata.

Reference

field	type	required	description
type	string	true	Must be "bigquery-list-table-ids".
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.

2.3 KiB Raw Blame History

About

Example

Reference

2.3 KiB

Raw Blame History