yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-26 18:06:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOC - Updated custom sql documentation (#15440)

Browse Source
This commit is contained in:
Teddy 2024-03-05 13:00:25 +01:00 committed by GitHub
parent 491aeb1b7f
commit b9e732c5cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
openmetadata-docs/content/v1.2.x/connectors/ingestion/workflows/data-quality/tests.md
View File

@ -270,19 +270,22 @@ parameterValues:
``` ```
### Table Custom SQL Test ### Table Custom SQL Test
Write you own SQL test. The test will pass if the following condition is met: Write you own SQL test. When writting your query you can use 2 strategies:
- The query result return 0 row - `ROWS` (default): expects the query to be written as `SELECT <field>, <field> FROM <foo> WHERE <condition>`. **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(<field>) FROM <foo> WHERE <condition>`.
**Properties** **Properties**
* `sqlExpression`: SQL expression * `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)
**Behavior** **Behavior**
| Condition | Status | | Condition | Status |
| ----------- | ----------- | | ----------- | ----------- |
|`sqlExpression` returns **0 row**|Success ✅| |`sqlExpression` returns **row <= threshold (default to 0)**|Success ✅|
|`sqlExpression` returns **1 or more rows**|Failed ❌| |`sqlExpression` returns **row > threshold (default to 0)**|Failed ❌|
**Example** **Example**
```sql ```sql

11
openmetadata-docs/content/v1.3.x/connectors/ingestion/workflows/data-quality/tests.md
View File

@ -292,19 +292,22 @@ Validate a list of table column name matches an expected set of columns
``` ```
### Table Custom SQL Test ### Table Custom SQL Test
Write you own SQL test. The test will pass if the following condition is met: Write you own SQL test. When writting your query you can use 2 strategies:
- The query result return 0 row - `ROWS` (default): expects the query to be written as `SELECT <field>, <field> FROM <foo> WHERE <condition>`. **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(<field>) FROM <foo> WHERE <condition>`.
**Properties** **Properties**
* `sqlExpression`: SQL expression * `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)
**Behavior** **Behavior**
| Condition | Status | | Condition | Status |
| ----------- | ----------- | | ----------- | ----------- |
|`sqlExpression` returns **0 row**|Success ✅| |`sqlExpression` returns **row <= threshold (default to 0)**|Success ✅|
|`sqlExpression` returns **1 or more rows**|Failed ❌| |`sqlExpression` returns **row > threshold (default to 0)**|Failed ❌|
**Example** **Example**
```sql ```sql