Skip to content

Commit f94bc9a

Browse files
committed
Documentation update for the top text values check.
1 parent 263e149 commit f94bc9a

File tree

7 files changed

+246
-146
lines changed

7 files changed

+246
-146
lines changed

docs/categories-of-data-quality-checks/how-to-validate-accepted-values-in-columns.md

+39
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,52 @@ spec:
5959

6060
![Asserting that all expected text values are present in a column](https://dqops.com/docs/images/concepts/categories-of-data-quality-checks/all-expected-column-values-are-in-use-data-quality-check-min.png){ loading=lazy }
6161

62+
``` { .yaml linenums="1" hl_lines="12-15" }
63+
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
64+
apiVersion: dqo/v1
65+
kind: table
66+
spec:
67+
columns:
68+
monitoring_checks:
69+
daily:
70+
accepted_values:
71+
daily_expected_text_values_in_use_count:
72+
parameters:
73+
expected_values:
74+
- TRAVIS
75+
- WILLIAMSON
76+
- HAYS
77+
- BASTROP
78+
error:
79+
max_missing: 0
80+
```
81+
6282
![Detecting expected values that are missing in a column](https://dqops.com/docs/images/concepts/categories-of-data-quality-checks/text-values-found-vs-text-values-in-use-min.png){ loading=lazy }
6383

6484
![Top values in a column to assert in a data quality check](https://dqops.com/docs/images/concepts/categories-of-data-quality-checks/column-profiling-result-top-two-column-values-min.png){ width="619px"; loading=lazy }
6585

6686

6787
![Asserting that expected values are in the top of most popular values in a column](https://dqops.com/docs/images/concepts/categories-of-data-quality-checks/text-values-in-top-most-popular-min.png){ loading=lazy }
6888

89+
``` { .yaml linenums="1" hl_lines="12-15" }
90+
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
91+
apiVersion: dqo/v1
92+
kind: table
93+
spec:
94+
columns:
95+
monitoring_checks:
96+
daily:
97+
accepted_values:
98+
daily_expected_texts_in_top_values_count:
99+
parameters:
100+
expected_values:
101+
- TRAVIS
102+
- WILLIAMSON
103+
top: 3
104+
error:
105+
max_missing: 0
106+
```
107+
69108
## Detecting accepted values issues
70109
How to detect accepted values data quality issues.
71110

docs/checks/column/accepted_values/expected-numbers-in-use-count.md

+40-20
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Please expand the section below to see the [DQOps command-line](../../../dqo-con
101101
The sample *schema_name.table_name.dqotable.yaml* file with the check configured is shown below.
102102

103103

104-
```yaml hl_lines="7-17"
104+
```yaml hl_lines="7-19"
105105
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
106106
apiVersion: dqo/v1
107107
kind: table
@@ -115,8 +115,10 @@ spec:
115115
expected_values:
116116
- 2
117117
- 3
118-
error:
118+
warning:
119119
max_missing: 0
120+
error:
121+
max_missing: 1
120122
fatal:
121123
max_missing: 2
122124
labels:
@@ -793,7 +795,7 @@ Expand the *Configure with data grouping* section to see additional examples for
793795
**Sample configuration with data grouping enabled (YAML)**
794796
The sample below shows how to configure the data grouping and how it affects the generated SQL query.
795797

796-
```yaml hl_lines="5-15 29-34"
798+
```yaml hl_lines="5-15 31-36"
797799
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
798800
apiVersion: dqo/v1
799801
kind: table
@@ -816,8 +818,10 @@ Expand the *Configure with data grouping* section to see additional examples for
816818
expected_values:
817819
- 2
818820
- 3
819-
error:
821+
warning:
820822
max_missing: 0
823+
error:
824+
max_missing: 1
821825
fatal:
822826
max_missing: 2
823827
labels:
@@ -1604,7 +1608,7 @@ Please expand the section below to see the [DQOps command-line](../../../dqo-con
16041608
The sample *schema_name.table_name.dqotable.yaml* file with the check configured is shown below.
16051609

16061610

1607-
```yaml hl_lines="7-18"
1611+
```yaml hl_lines="7-20"
16081612
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
16091613
apiVersion: dqo/v1
16101614
kind: table
@@ -1619,8 +1623,10 @@ spec:
16191623
expected_values:
16201624
- 2
16211625
- 3
1622-
error:
1626+
warning:
16231627
max_missing: 0
1628+
error:
1629+
max_missing: 1
16241630
fatal:
16251631
max_missing: 2
16261632
labels:
@@ -2297,7 +2303,7 @@ Expand the *Configure with data grouping* section to see additional examples for
22972303
**Sample configuration with data grouping enabled (YAML)**
22982304
The sample below shows how to configure the data grouping and how it affects the generated SQL query.
22992305

2300-
```yaml hl_lines="5-15 30-35"
2306+
```yaml hl_lines="5-15 32-37"
23012307
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
23022308
apiVersion: dqo/v1
23032309
kind: table
@@ -2321,8 +2327,10 @@ Expand the *Configure with data grouping* section to see additional examples for
23212327
expected_values:
23222328
- 2
23232329
- 3
2324-
error:
2330+
warning:
23252331
max_missing: 0
2332+
error:
2333+
max_missing: 1
23262334
fatal:
23272335
max_missing: 2
23282336
labels:
@@ -3109,7 +3117,7 @@ Please expand the section below to see the [DQOps command-line](../../../dqo-con
31093117
The sample *schema_name.table_name.dqotable.yaml* file with the check configured is shown below.
31103118

31113119

3112-
```yaml hl_lines="7-18"
3120+
```yaml hl_lines="7-20"
31133121
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
31143122
apiVersion: dqo/v1
31153123
kind: table
@@ -3124,8 +3132,10 @@ spec:
31243132
expected_values:
31253133
- 2
31263134
- 3
3127-
error:
3135+
warning:
31283136
max_missing: 0
3137+
error:
3138+
max_missing: 1
31293139
fatal:
31303140
max_missing: 2
31313141
labels:
@@ -3802,7 +3812,7 @@ Expand the *Configure with data grouping* section to see additional examples for
38023812
**Sample configuration with data grouping enabled (YAML)**
38033813
The sample below shows how to configure the data grouping and how it affects the generated SQL query.
38043814

3805-
```yaml hl_lines="5-15 30-35"
3815+
```yaml hl_lines="5-15 32-37"
38063816
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
38073817
apiVersion: dqo/v1
38083818
kind: table
@@ -3826,8 +3836,10 @@ Expand the *Configure with data grouping* section to see additional examples for
38263836
expected_values:
38273837
- 2
38283838
- 3
3829-
error:
3839+
warning:
38303840
max_missing: 0
3841+
error:
3842+
max_missing: 1
38313843
fatal:
38323844
max_missing: 2
38333845
labels:
@@ -4614,7 +4626,7 @@ Please expand the section below to see the [DQOps command-line](../../../dqo-con
46144626
The sample *schema_name.table_name.dqotable.yaml* file with the check configured is shown below.
46154627

46164628

4617-
```yaml hl_lines="12-23"
4629+
```yaml hl_lines="12-25"
46184630
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
46194631
apiVersion: dqo/v1
46204632
kind: table
@@ -4634,8 +4646,10 @@ spec:
46344646
expected_values:
46354647
- 2
46364648
- 3
4637-
error:
4649+
warning:
46384650
max_missing: 0
4651+
error:
4652+
max_missing: 1
46394653
fatal:
46404654
max_missing: 2
46414655
labels:
@@ -5321,7 +5335,7 @@ Expand the *Configure with data grouping* section to see additional examples for
53215335
**Sample configuration with data grouping enabled (YAML)**
53225336
The sample below shows how to configure the data grouping and how it affects the generated SQL query.
53235337

5324-
```yaml hl_lines="10-20 40-45"
5338+
```yaml hl_lines="10-20 42-47"
53255339
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
53265340
apiVersion: dqo/v1
53275341
kind: table
@@ -5350,8 +5364,10 @@ Expand the *Configure with data grouping* section to see additional examples for
53505364
expected_values:
53515365
- 2
53525366
- 3
5353-
error:
5367+
warning:
53545368
max_missing: 0
5369+
error:
5370+
max_missing: 1
53555371
fatal:
53565372
max_missing: 2
53575373
labels:
@@ -6141,7 +6157,7 @@ Please expand the section below to see the [DQOps command-line](../../../dqo-con
61416157
The sample *schema_name.table_name.dqotable.yaml* file with the check configured is shown below.
61426158

61436159

6144-
```yaml hl_lines="12-23"
6160+
```yaml hl_lines="12-25"
61456161
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
61466162
apiVersion: dqo/v1
61476163
kind: table
@@ -6161,8 +6177,10 @@ spec:
61616177
expected_values:
61626178
- 2
61636179
- 3
6164-
error:
6180+
warning:
61656181
max_missing: 0
6182+
error:
6183+
max_missing: 1
61666184
fatal:
61676185
max_missing: 2
61686186
labels:
@@ -6848,7 +6866,7 @@ Expand the *Configure with data grouping* section to see additional examples for
68486866
**Sample configuration with data grouping enabled (YAML)**
68496867
The sample below shows how to configure the data grouping and how it affects the generated SQL query.
68506868

6851-
```yaml hl_lines="10-20 40-45"
6869+
```yaml hl_lines="10-20 42-47"
68526870
# yaml-language-server: $schema=https://cloud.dqops.com/dqo-yaml-schema/TableYaml-schema.json
68536871
apiVersion: dqo/v1
68546872
kind: table
@@ -6877,8 +6895,10 @@ Expand the *Configure with data grouping* section to see additional examples for
68776895
expected_values:
68786896
- 2
68796897
- 3
6880-
error:
6898+
warning:
68816899
max_missing: 0
6900+
error:
6901+
max_missing: 1
68826902
fatal:
68836903
max_missing: 2
68846904
labels:

0 commit comments

Comments
 (0)