From 70e1643bd836111cf4f8ede51103d4d8fdc42978 Mon Sep 17 00:00:00 2001 From: Teddy Date: Tue, 5 Mar 2024 13:46:48 +0100 Subject: [PATCH] doc: added threshold details (#15458) --- .../connectors/ingestion/workflows/data-quality/tests.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/openmetadata-docs/content/v1.3.x/connectors/ingestion/workflows/data-quality/tests.md b/openmetadata-docs/content/v1.3.x/connectors/ingestion/workflows/data-quality/tests.md index e734c3ef414..2a7e6f021d5 100644 --- a/openmetadata-docs/content/v1.3.x/connectors/ingestion/workflows/data-quality/tests.md +++ b/openmetadata-docs/content/v1.3.x/connectors/ingestion/workflows/data-quality/tests.md @@ -296,11 +296,14 @@ Write you own SQL test. When writting your query you can use 2 strategies: - `ROWS` (default): expects the query to be written as `SELECT , FROM WHERE `. **Note** if your query returns a large amount of rows it might cause an "Out Of Memeory" error. In this case we recoomend you to use the `COUNT` startegy. - `COUNT`: expects the query to be written as `SELECT COUNT() FROM WHERE `. +**How to use the Threshold Parameter?** +The threshold allows you to define a limit for which you test should pass or fail - by defaut this number is 0. For example if my custom SQL query test returns 10 rows and my threshold is 5 the test will fail. If I update my threshold to 11 on my next run my test will pass. + **Properties** * `sqlExpression`: SQL expression * `strategy`: one of `ROWS` or `COUNT` -* `threshold`: and integer defining the threshold above which the test should fail (default to 0 if not specified) +* `threshold`: an integer defining the threshold above which the test should fail (default to 0 if not specified) **Behavior**