bigquery-list-table-ids

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

About

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

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

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

Reference

fieldtyperequireddescription
kindstringtrueMust be “bigquery-list-table-ids”.
sourcestringtrueName of the source the SQL should execute on.
descriptionstringtrueDescription of the tool that is passed to the LLM.