yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-16 03:08:13 +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

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

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