Sql Validator

October 20, 2022 17:28

Specification

{
  "validatorType": String,
  "name": String,
  "description": String,
  "fields": FieldSelectorSpec,
  "sql": String,
  "onNullResult": String
}

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
sql	String	A partial SQL expression representing an arbitrary operation that results in a boolean value. This would be a clause in the `select` statement of a SQL query. Use `$column` to represent the name of the field selected by the field selector.	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

Example

{
  "validatorType": "sql",
  "name": "sample_sql_validator",
  "description": "I can execute arbitrary sql",
  "fields": {
    "fieldSelectorType": "Single",
    "fieldName": "col_name"
  },
  "sql": "editdistance($column, 'benchmark') < 4",
  "onNullResult": "pass"
}