bigquery-get-dataset-info Tool
A “bigquery-get-dataset-info” tool retrieves metadata for a BigQuery dataset.
less than a minute
About
A bigquery-get-dataset-info tool retrieves metadata for a BigQuery dataset.
bigquery-get-dataset-info accepts the following parameters:
dataset(required): Specifies the dataset for which to retrieve metadata.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 retrieve metadata for any dataset specified by thedatasetandprojectparameters. - With
allowedDatasetsrestriction: Before retrieving metadata, 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
This tool can be used with the following database sources:
| Source Name |
|---|
| BigQuery Source |
Example
kind: tools
name: bigquery_get_dataset_info
type: bigquery-get-dataset-info
source: my-bigquery-source
description: Use this tool to get dataset metadata.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “bigquery-get-dataset-info”. |
| 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. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.