Lookup Validator

July 27, 2022 14:16

Specification

{
  "validatorType": String,
  "name": String,
  "description": String,
  "fields": FieldSelectorSpec,
  "lookupTableSchema": String,
  "lookupTable": String,
  "lookupColumn": String,
  "onNullResult": String,
  "caseSensitive": Boolean
}

Structure Values

Field Name	Type	Description	Required	Default
validatorType	String	The type of validator to construct	Required
name	String	The name of the validator. Must be unique within the validation suite.	Required
description	String	Expanded validator information.		None
fields	Object	A Field Selector Spec	Required
lookupTableSchema	String	The name of the schema the lookup table will be in.		None
lookupTable	String	The name of the lookup table to be used in the validator.	Required
lookupColumn	String	The column from the lookup table to be joined with the original table to test the validator with.	Required
onNullResult	String	A value of pass, null, or fail that describes how to process null values. Null aggregates them into a null column. Pass aggregates them in with the other passing values. Fail aggregates them in with the other failing values.		null
caseSensitive	Boolean	Applies case-sensitivity to comparisons with the column value and the values in the lookup list.		true

Example

{
  "validatorType": "lookup",
  "name": "sample_lookup_validator",
  "description": "I can validate from another table",
  "fields": {
    "fieldSelectorType": "Single",
    "fieldName": "col_name"
  },
  "lookupTableSchema": "sample_schema",
  "lookupTable": "sample_table",
  "lookupColumn": "sample_column_name",
  "onNullResult": "pass",
  "caseSensitive": false
}