Skip to content

docs: BigQuery nested STRUCT support in anomaly tests #2349

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
NoyaOffer merged 1 commit into from
Sep 10, 2026
Merged

docs: BigQuery nested STRUCT support in anomaly tests #2349

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
4 changes: 4 additions & 0 deletions docs/data-tests/anomaly-detection-tests/all-columns-anomalies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Specific monitors are detailed in the table below and can be configured using th
The test checks the data type of each column and only executes monitors that are relevant to it.
You can use `column_anomalies` param to override the default monitors, and `exclude_prefix` / `exclude_regexp` to exclude columns from the test.

<Note>
**BigQuery: nested STRUCT fields.** `all_columns_anomalies` monitors top-level columns and does not automatically expand nested STRUCT fields. To monitor a nested field, add a [`column_anomalies`](/data-tests/anomaly-detection-tests/column-anomalies) test that references it by its dotted path, for example `user.address.city`. Fields under a `REPEATED` (array) ancestor are not supported.
</Note>

<ColumnMetrics />

### Test configuration
Expand Down
3 changes: 3 additions & 0 deletions docs/data-tests/anomaly-detection-tests/column-anomalies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebarTitle: "Column anomalies"

import AiGenerateTest from '/snippets/ai-generate-test.mdx';
import ColumnMetrics from '/snippets/column-metrics.mdx';
import BigQueryNestedStruct from '/snippets/data-tests/bigquery-nested-struct-anomalies.mdx';


<AiGenerateTest />
Expand All @@ -16,6 +17,8 @@ Specific monitors are detailed in the table below and can be configured using th

The test checks the data type of the column and only executes monitors that are relevant to it.

<BigQueryNestedStruct />

<ColumnMetrics />

### Test configuration
Expand Down
3 changes: 3 additions & 0 deletions docs/data-tests/anomaly-detection-tests/dimension-anomalies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: "dimension_anomalies"
---

import AiGenerateTest from '/snippets/ai-generate-test.mdx';
import BigQueryNestedStruct from '/snippets/data-tests/bigquery-nested-struct-anomalies.mdx';


<AiGenerateTest />
Expand All @@ -13,6 +14,8 @@ import AiGenerateTest from '/snippets/ai-generate-test.mdx';

The test counts rows grouped by given `dimensions` (columns/expressions).

<BigQueryNestedStruct />

This test practically monitors the frequency of values in the configured dimension over time, and alerts on unexpected changes in the distribution.
It is best to configure it on low-cardinality fields.

Expand Down
5 changes: 5 additions & 0 deletions docs/snippets/data-tests/bigquery-nested-struct-anomalies.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Note>
**BigQuery: nested STRUCT fields.** On BigQuery you can reference nested STRUCT leaf fields by their dotted path, for example `user.address.city`, wherever you name a column or dimension in this test. There is no need to flatten them into their own columns first, and the full dotted path is preserved in alerts.

Fields under a `REPEATED` (array) ancestor are not supported.
</Note>
Loading