Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sqlbuild.com/llms.txt

Use this file to discover all available pages before exploring further.

BigQuery requires the optional google-cloud-bigquery dependency:
pip install 'sqlbuild[bigquery]'
# or
uv add 'sqlbuild[bigquery]'

Connection config

adapter: bigquery

connection:
  project: my-gcp-project
  location: europe-west2
FieldDescription
projectGCP project ID (required)
locationBigQuery dataset location - a region (europe-west2, us-east1) or multi-region (US, EU)
credentials_pathPath to a service account JSON key file. If omitted, uses Application Default Credentials (ADC).

Authentication

BigQuery supports two authentication methods: Application Default Credentials (default): Uses the credentials from gcloud auth application-default login or the environment’s service account. No config needed beyond project. Service account file:
connection:
  project: my-gcp-project
  credentials_path: /path/to/service-account.json