Skip to content

Commit 6557b3a

Browse files
committed
docs: add new optional bigquery settings to documentation
1 parent 96f904b commit 6557b3a

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

BIGQUERY.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ This section covers connecting to BigQuery.
1616

1717
* `BIGQUERY_PROJECT`: The GCP project ID.
1818
* `BIGQUERY_LOCATION`: (Optional) Location of the BigQuery resources.
19+
* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Whether to use client OAuth (default: false).
20+
* `BIGQUERY_SCOPES`: (Optional) Scopes for the BigQuery client.
21+
* `BIGQUERY_MAX_QUERY_RESULT_ROWS`: (Optional) Maximum number of query result rows (default: 50).
22+
* `BIGQUERY_IMPERSONATE_SERVICE_ACCOUNT`: (Optional) Service account to impersonate.
1923

2024
If you need to update any of these values later, use the `gemini extensions config bigquery-data-analytics` command.
2125

@@ -38,6 +42,10 @@ Users may have set project environment variables:
3842

3943
* `BIGQUERY_PROJECT`: The GCP project ID.
4044
* `BIGQUERY_LOCATION`: (Optional) Location of the BigQuery resources.
45+
* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Whether to use client OAuth (default: false).
46+
* `BIGQUERY_SCOPES`: (Optional) Scopes for the BigQuery client.
47+
* `BIGQUERY_MAX_QUERY_RESULT_ROWS`: (Optional) Maximum number of query result rows (default: 50).
48+
* `BIGQUERY_IMPERSONATE_SERVICE_ACCOUNT`: (Optional) Service account to impersonate.
4149

4250
Instead of prompting the user for these values for specific skill calls, prompt the user to verify the reuse of a specific setting value.
4351
Make sure to not use the environment variable name like `BIGQUERY_PROJECT`, `${BIGQUERY_PROJECT}`, or `$BIGQUERY_PROJECT`.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ You will be prompted to configure the following settings during installation. Th
4747

4848
* `BIGQUERY_PROJECT`: The GCP project ID.
4949
* `BIGQUERY_LOCATION`: (Optional) The dataset location.
50+
* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Whether to use client OAuth (default: false).
51+
* `BIGQUERY_SCOPES`: (Optional) Scopes for the BigQuery client.
52+
* `BIGQUERY_MAX_QUERY_RESULT_ROWS`: (Optional) Maximum number of query result rows (default: 50).
53+
* `BIGQUERY_IMPERSONATE_SERVICE_ACCOUNT`: (Optional) Service account to impersonate.
5054

5155
To view or update your configuration:
5256

@@ -65,6 +69,10 @@ Alternatively, you can manually set these environment variables before starting
6569
```bash
6670
export BIGQUERY_PROJECT="<your-gcp-project-id>"
6771
export BIGQUERY_LOCATION="<your-dataset-location>" # Optional
72+
export BIGQUERY_USE_CLIENT_OAUTH="false" # Optional
73+
export BIGQUERY_SCOPES="" # Optional
74+
export BIGQUERY_MAX_QUERY_RESULT_ROWS="50" # Optional
75+
export BIGQUERY_IMPERSONATE_SERVICE_ACCOUNT="" # Optional
6876
```
6977

7078
> [!NOTE]

0 commit comments

Comments
 (0)