Skip to content

document query_label session property #5683

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

Merged
izeigerman merged 1 commit into from
Jan 26, 2026
Merged

document query_label session property #5683

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
17 changes: 17 additions & 0 deletions docs/integrations/engines/bigquery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,23 @@ If the `impersonated_service_account` argument is set, SQLMesh will:

The user account must have [sufficient permissions to impersonate the service account](https://cloud.google.com/docs/authentication/use-service-account-impersonation).

## Query Label

BigQuery supports a `query_label` session variable which is attached to query jobs and can be used for auditing / attribution.

SQLMesh supports setting it via `session_properties.query_label` on a model, as an array (or tuple) of key/value tuples.

Example:
```sql
MODEL (
name my_project.my_dataset.my_model,
dialect 'bigquery',
session_properties (
query_label = [('team', 'data_platform'), ('env', 'prod')]
)
);
```

## Permissions Required
With any of the above connection methods, ensure these BigQuery permissions are enabled to allow SQLMesh to work correctly.

Expand Down