wehub-resource-sync
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-get-table-info | docs | 1 | A "bigquery-get-table-info" tool retrieves metadata for a BigQuery table. |
About
A bigquery-get-table-info tool retrieves metadata for a BigQuery table.
bigquery-get-table-info accepts the following parameters:
table(required): The name of the table for which to retrieve metadata.dataset(required): The dataset containing the specified table.project(optional): 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 table specified by thetable,dataset, andprojectparameters. - 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
{{< compatible-sources >}}
Example
kind: tool
name: bigquery_get_table_info
type: bigquery-get-table-info
source: my-bigquery-source
description: Use this tool to get table metadata.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be "bigquery-get-table-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. |