e04ed9c211
CF: Deploy Dev Docs / deploy (push) Has been cancelled
Sync Labels / build (push) Has been cancelled
tests / unit tests (macos-latest) (push) Has been cancelled
tests / unit tests (windows-latest) (push) Has been cancelled
tests / unit tests (ubuntu-latest) (push) Has been cancelled
2.2 KiB
2.2 KiB
title, type, weight, description
| title | type | weight | description |
|---|---|---|---|
| bigquery-list-table-ids | docs | 1 | 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.
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
allowedDatasetsrestriction: The tool can list tables from any dataset specified by thedatasetandprojectparameters. - With
allowedDatasetsrestriction: 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 theallowedDatasetslist, it will be used as the default value for thedatasetparameter.
Compatible Sources
{{< compatible-sources >}}
Example
kind: tool
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. |