json.schema.tests.tableTest.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-core Show documentation
The newest version!
{
  "$id": "https://open-metadata.org/schema/tests/tableTest.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TableTest",
  "description": "TableTest is a test definition to capture data quality tests against tables and columns.",
  "type": "object",
  "javaType": "org.openmetadata.catalog.tests.TableTest",
  "definitions": {
    "tableTestCase": {
      "description": "Table Test Case.",
      "type": "object",
      "javaType": "org.openmetadata.catalog.tests.TableTestCase",
      "properties": {
        "config": {
          "oneOf": [
            {
              "$ref": "./table/tableRowCountToEqual.json"
            },
            {
              "$ref": "./table/tableRowCountToBeBetween.json"
            },
            {
              "$ref": "./table/tableColumnCountToEqual.json"
            },
            {
              "$ref": "./table/tableColumnCountToBeBetween.json"
            },
            {
              "$ref": "./table/tableColumnNameToExist.json"
            },
            {
              "$ref": "./table/tableColumnToMatchSet.json"
            }
          ]
        },
        "tableTestType": {
          "enum": [
            "tableRowCountToEqual",
            "tableRowCountToBeBetween",
            "tableColumnCountToEqual",
            "tableColumnCountToBeBetween",
            "tableColumnToMatchSet",
            "tableColumnNameToExist"
          ]
        }
      },
      "additionalProperties": false
    }
  },
  "properties": {
    "id": {
      "description": "Unique identifier of this table instance.",
      "$ref": "../type/basic.json#/definitions/uuid"
    },
    "name": {
      "description": "Name that identifies this test case.",
      "$ref": "../type/basic.json#/definitions/entityName"
    },
    "description": {
      "description": "Description of the testcase.",
      "$ref": "../type/basic.json#/definitions/markdown"
    },
    "testCase": {
      "$ref": "#/definitions/tableTestCase"
    },
    "executionFrequency": {
      "$ref": "./basic.json#/definitions/testCaseExecutionFrequency"
    },
    "results": {
      "description": "List of results of the test case.",
      "type": "array",
      "items": {
        "$ref": "./basic.json#/definitions/testCaseResult"
      }
    },
    "owner": {
      "description": "Owner of this Pipeline.",
      "$ref": "../type/entityReference.json",
      "default": null
    },
    "updatedAt": {
      "description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
      "$ref": "../type/basic.json#/definitions/timestamp"
    },
    "updatedBy": {
      "description": "User who made the update.",
      "type": "string"
    }
  },
  "required": ["name", "testCase"],
  "additionalProperties": false
}