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

doc: updated test cases documentation (#15325)

Browse Source
This commit is contained in:
Teddy 2024-02-23 09:22:23 +01:00 committed by GitHub
parent 6ec468def7
commit 358316917f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 167 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -39,16 +39,20 @@ Validate the total row count in the table is equal to the given value.
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: tableRowCountToEqual - name: myTestName
parameterValues: description: test description
- name: value testDefinitionName: tableRowCountToEqual
value: 2 parameterValues:
- name: value
value: 2
``` ```
**JSON Config** **JSON Config**
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"testDefinitionName": "tableRowCountToEqual", "testDefinitionName": "tableRowCountToEqual",
"parameterValues": [ "parameterValues": [
{ {
@ -79,8 +83,10 @@ Any of those two need to be informed.
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: tableRowCountToBeBetween - name: myTestName
parameterValues: description: test description
testDefinitionName: tableRowCountToBeBetween
parameterValues:
- name: minValue - name: minValue
value: 10 value: 10
- name: maxValue - name: maxValue
@ -91,6 +97,8 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"testDefinitionName": "tableRowCountToBeBetween", "testDefinitionName": "tableRowCountToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -122,8 +130,10 @@ Validate that the number of columns in a table is equal to a given value.
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: tableColumnCountToEqual - name: myTestName
parameterValues: description: test description
testDefinitionName: tableColumnCountToEqual
parameterValues:
- name: columnCount - name: columnCount
value: 5 value: 5
``` ```
@ -132,6 +142,8 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"testDefinitionName": "tableColumnCountToEqual", "testDefinitionName": "tableColumnCountToEqual",
"parameterValues": [ "parameterValues": [
{ {
@ -160,8 +172,10 @@ Validate the number of columns in a table is between the given value
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: tableColumnCountToBeBetween - name: myTestName
parameterValues: description: test description
testDefinitionName: tableColumnCountToBeBetween
parameterValues:
- name: minColValue - name: minColValue
value: 5 value: 5
- name: maxColValue - name: maxColValue
@ -172,6 +186,8 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"testDefinitionName": "tableColumnCountToBeBetween", "testDefinitionName": "tableColumnCountToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -203,8 +219,10 @@ Validate a column name is present in the table
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: tableColumnNameToExist - name: myTestName
parameterValues: description: test description
testDefinitionName: tableColumnNameToExist
parameterValues:
- name: columnName - name: columnName
value: order_id value: order_id
``` ```
@ -213,6 +231,7 @@ parameterValues:
```json ```json
{ {
"myTestName": "myTestName",
"testDefinitionName": "tableColumnNameToExist", "testDefinitionName": "tableColumnNameToExist",
"parameterValues": [ "parameterValues": [
{ {
@ -243,8 +262,10 @@ Validate a list of table column name matches an expected set of columns
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: tableColumnToMatchSet - name: myTestName
parameterValues: description: test description
testDefinitionName: tableColumnToMatchSet
parameterValues:
- name: columnNames - name: columnNames
value: "col1, col2, col3" value: "col1, col2, col3"
- name: ordered - name: ordered
@ -255,6 +276,7 @@ parameterValues:
```json ```json
{ {
"myTestName": "myTestName",
"testDefinitionName": "tableColumnToMatchSet", "testDefinitionName": "tableColumnToMatchSet",
"parameterValues": [ "parameterValues": [
{ {
@ -303,8 +325,10 @@ WHERE lifetime_value < 0;
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: tableCustomSQLQuery - name: myTestName
parameterValues: description: test description
testDefinitionName: tableCustomSQLQuery
parameterValues:
- name: sqlExpression - name: sqlExpression
value: > value: >
SELECT SELECT
@ -317,6 +341,8 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"testDefinitionName": "tableCustomSQLQuery", "testDefinitionName": "tableCustomSQLQuery",
"parameterValues": [ "parameterValues": [
{ {
@ -354,8 +380,10 @@ The Table Row Inserted Count To Be Between cannot be executed against tables tha
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: tableRowInsertedCountToBeBetween - name: myTestName
parameterValues: description: test description
testDefinitionName: tableRowInsertedCountToBeBetween
parameterValues:
- name: min - name: min
value: 10 value: 10
- name: max - name: max
@ -372,6 +400,8 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"testDefinitionName": "tableRowInsertedCountToBeBetween", "testDefinitionName": "tableRowInsertedCountToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -433,8 +463,11 @@ Makes sure that there are no duplicate values in a given column.
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValuesToBeUnique - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValuesToBeUnique
parameterValues:
- name: columnNames - name: columnNames
value: true value: true
``` ```
@ -443,6 +476,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesToBeUnique", "testDefinitionName": "columnValuesToBeUnique",
"parameterValues": [ "parameterValues": [
{ {
@ -470,8 +506,11 @@ Validates that there are no null values in the column.
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValuesToBeNotNull - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValuesToBeNotNull
parameterValues:
- name: columnValuesToBeNotNull - name: columnValuesToBeNotNull
value: true value: true
``` ```
@ -480,6 +519,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesToBeNotNull", "testDefinitionName": "columnValuesToBeNotNull",
"parameterValues": [ "parameterValues": [
{ {
@ -517,8 +559,11 @@ The other databases will fall back to the `LIKE` expression
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValuesToMatchRegex - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValuesToMatchRegex
parameterValues:
- name: regex - name: regex
value: "%something%" value: "%something%"
``` ```
@ -527,6 +572,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesToMatchRegex", "testDefinitionName": "columnValuesToMatchRegex",
"parameterValues": [ "parameterValues": [
{ {
@ -564,8 +612,11 @@ The other databases will fall back to the `LIKE` expression
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValuesToMatchRegex - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValuesToMatchRegex
parameterValues:
- name: forbiddenRegex - name: forbiddenRegex
value: "%something%" value: "%something%"
``` ```
@ -574,6 +625,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesToMatchRegex", "testDefinitionName": "columnValuesToMatchRegex",
"parameterValues": [ "parameterValues": [
{ {
@ -611,6 +665,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesToBeInSet", "testDefinitionName": "columnValuesToBeInSet",
"parameterValues": [ "parameterValues": [
{ {
@ -641,8 +698,11 @@ Validate that there are no values in a column in a set of forbidden values.
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValuesToBeNotInSet - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValuesToBeNotInSet
parameterValues:
- name: forbiddenValues - name: forbiddenValues
value: ["forbidden1", "forbidden2"] value: ["forbidden1", "forbidden2"]
``` ```
@ -651,6 +711,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesToBeNotInSet", "testDefinitionName": "columnValuesToBeNotInSet",
"parameterValues": [ "parameterValues": [
{ {
@ -689,8 +752,11 @@ Any of those two need to be informed.
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValuesToBeBetween - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValuesToBeBetween
parameterValues:
- name: minValue - name: minValue
value: ["forbidden1", "forbidden2"] value: ["forbidden1", "forbidden2"]
``` ```
@ -699,6 +765,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesToBeBetween", "testDefinitionName": "columnValuesToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -730,8 +799,11 @@ Validates that the number of missing values matches a given number. Missing valu
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValuesMissingCountToBeEqual - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValuesMissingCountToBeEqual
parameterValues:
- name: missingValueMatch - name: missingValueMatch
value: ["NA", "N/A"] value: ["NA", "N/A"]
- name: missingCountValue - name: missingCountValue
@ -742,6 +814,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesMissingCountToBeEqual", "testDefinitionName": "columnValuesMissingCountToBeEqual",
"parameterValues": [ "parameterValues": [
{ {
@ -763,6 +838,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValuesMissingCountToBeEqual", "testDefinitionName": "columnValuesMissingCountToBeEqual",
"parameterValues": [ "parameterValues": [
{ {
@ -805,8 +883,11 @@ Any of those two need to be informed.
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValueLengthsToBeBetween - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValueLengthsToBeBetween
parameterValues:
- name: minLength - name: minLength
value: 50 value: 50
- name: maxLength - name: maxLength
@ -817,6 +898,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValueLengthsToBeBetween", "testDefinitionName": "columnValueLengthsToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -854,8 +938,11 @@ Validate the maximum value of a column is between a specific range
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValueMaxToBeBetween - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValueMaxToBeBetween
parameterValues:
- name: minValueForMaxInCol - name: minValueForMaxInCol
value: 50 value: 50
- name: maxValueForMaxInCol - name: maxValueForMaxInCol
@ -866,6 +953,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValueMaxToBeBetween", "testDefinitionName": "columnValueMaxToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -903,8 +993,11 @@ Validate the minimum value of a column is between a specific range
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValueMinToBeBetween - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValueMinToBeBetween
parameterValues:
- name: minValueForMinInCol - name: minValueForMinInCol
value: 10 value: 10
- name: maxValueForMinInCol - name: maxValueForMinInCol
@ -915,6 +1008,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValueMinToBeBetween", "testDefinitionName": "columnValueMinToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -952,8 +1048,11 @@ Validate the mean of a column is between a specific range
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValueMeanToBeBetween - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValueMeanToBeBetween
parameterValues:
- name: minValueForMeanInCol - name: minValueForMeanInCol
value: 5 value: 5
- name: maxValueForMeanInCol - name: maxValueForMeanInCol
@ -964,6 +1063,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValueMeanToBeBetween", "testDefinitionName": "columnValueMeanToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -1001,8 +1103,11 @@ Validate the median of a column is between a specific range
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValueMedianToBeBetween - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValueMedianToBeBetween
parameterValues:
- name: minValueForMedianInCol - name: minValueForMedianInCol
value: 5 value: 5
- name: maxValueForMedianInCol - name: maxValueForMedianInCol
@ -1013,6 +1118,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValueMedianToBeBetween", "testDefinitionName": "columnValueMedianToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -1050,8 +1158,11 @@ Validate the sum of a column is between a specific range
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValueMedianToBeBetween - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValueMedianToBeBetween
parameterValues:
- name: minValueForMedianInCol - name: minValueForMedianInCol
value: 5 value: 5
- name: maxValueForMedianInCol - name: maxValueForMedianInCol
@ -1062,6 +1173,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValueMedianToBeBetween", "testDefinitionName": "columnValueMedianToBeBetween",
"parameterValues": [ "parameterValues": [
{ {
@ -1099,8 +1213,11 @@ Validate the standard deviation of a column is between a specific range
**YAML Config** **YAML Config**
```yaml ```yaml
testDefinitionName: columnValueStdDevToBeBetween - name: myTestName
parameterValues: description: test description
columnName: columnName
testDefinitionName: columnValueStdDevToBeBetween
parameterValues:
- name: minValueForStdDevInCol - name: minValueForStdDevInCol
value: 5 value: 5
- name: maxValueForStdDevInCol - name: maxValueForStdDevInCol
@ -1111,6 +1228,9 @@ parameterValues:
```json ```json
{ {
"name": "myTestName",
"description": "test description",
"columnName": "columnName",
"testDefinitionName": "columnValueStdDevToBeBetween", "testDefinitionName": "columnValueStdDevToBeBetween",
"parameterValues": [ "parameterValues": [
{ {