Skip to content

feat(bigquery): document BIGQUERY_MAXIMUM_BYTES_BILLED support #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Abhishek21g wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(bigquery): document BIGQUERY_MAXIMUM_BYTES_BILLED support #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,11 +266,13 @@ BigQuery is Google Cloud's fully managed, petabyte-scale analytics data warehous
```bash
BIGQUERY_PROJECT=my-project \
BIGQUERY_DATASET=my_dataset \
BIGQUERY_MAXIMUM_BYTES_BILLED=1073741824 \
GOOGLE_APPLICATION_CREDENTIALS=/creds/sa.json \
docker run --rm -i \
--name mcp-bigquery \
-e BIGQUERY_PROJECT \
-e BIGQUERY_DATASET \
-e BIGQUERY_MAXIMUM_BYTES_BILLED \
-e GOOGLE_APPLICATION_CREDENTIALS \
-v /path/to/service-account.json:/creds/sa.json \
us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:latest \
Expand All @@ -289,13 +291,15 @@ docker run --rm -i \
"-e", "GOOGLE_APPLICATION_CREDENTIALS=/creds/sa.json",
"-e", "BIGQUERY_PROJECT",
"-e", "BIGQUERY_DATASET",
"-e", "BIGQUERY_MAXIMUM_BYTES_BILLED",
"us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:latest",
"--prebuilt", "bigquery",
"--stdio"
],
"env": {
"BIGQUERY_PROJECT": "my-project",
"BIGQUERY_DATASET": "my_dataset",
"BIGQUERY_MAXIMUM_BYTES_BILLED": "1073741824",
"GOOGLE_APPLICATION_CREDENTIALS_PATH": "/path/to/service-account.json"
}
}
Expand All @@ -308,6 +312,7 @@ docker run --rm -i \
| `BIGQUERY_PROJECT` | Yes | GCP project ID | - | `my-project` |
| `BIGQUERY_DATASET` | Yes | Default dataset | - | `my_dataset` |
| `BIGQUERY_LOCATION` | No | BigQuery location | `US` | `US`, `EU` |
| `BIGQUERY_MAXIMUM_BYTES_BILLED` | No | Per-query bytes scanned cap. Queries exceeding this limit fail before executing. | `0` (no limit) | `1073741824` (1 GiB) |
| `GOOGLE_APPLICATION_CREDENTIALS_PATH` | Yes | Path to service account JSON | - | `/path/to/service-account.json` |


Expand Down
4 changes: 4 additions & 0 deletions images/bigquery/entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ main() {
log "ERROR: Failed to setup Google Cloud credentials"
exit 1
fi

if [[ -n "${BIGQUERY_MAXIMUM_BYTES_BILLED:-}" ]]; then
log "Per-query bytes billed cap: ${BIGQUERY_MAXIMUM_BYTES_BILLED}"
fi

# Execute the original toolbox with BigQuery prebuilt and passed arguments
log "Executing BigQuery toolbox with arguments: $*"
Expand Down