Module Values.RuleSource

Represents a single data quality requirement that should be validated in the scope of this dataset.

Sourcetype nonrec t = {
  1. name : RuleName.t;
    (*

    The name of the rule.

    *)
  2. disabled : Disabled.t option;
    (*

    A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

    *)
  3. checkExpression : Expression.t;
    (*

    The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2. For more information, see Available checks

    *)
  4. substitutionMap : ValuesMap.t option;
    (*

    The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "`Column A`".

    *)
  5. threshold : Threshold.t option;
    (*

    The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

    *)
  6. columnSelectors : ColumnSelectorList.t option;
    (*

    List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

    *)
}
Sourceval context_ : string
Sourceval make : ?disabled:??? -> ?substitutionMap:??? -> ?threshold:??? -> ?columnSelectors:??? -> name:RuleName.t -> checkExpression:Expression.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Disabled.t | `List of [> `Structure of (string * [> `String of ColumnName.t ]) list ] list | `Map of ([> `String of ValueReference.t ] * [> `String of ConditionValue.t ]) list | `String of RuleName.t | `Structure of (string * [> `Double of ThresholdValue.t | `Enum of string ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t