Regex Validator

July 27, 2022 14:16

Specification

{
  "validatorType": String,
  "name": String,
  "description": String,
  "fields": FieldSelectorSpec,
  "pattern": String,
  "onNullResult": String
  "castFields": 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
pattern	String	A regex pattern. Must be escaped inside of a JSON block.	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
castFields	Boolean	Specifies if target fields should be cast to a string prior to validation.		false

Example

{
  "validatorType": "regex",
  "name": "sample_regex_validator",
  "description": "I can validate strings",
  "fields": {
    "fieldSelectorType": "Single",
    "fieldName": "col_name"
  },
  "pattern": "\\w{4}", // the backslash in "\w" must be escaped,
  "onNullResult": "pass",
  "castFields": false
}