Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Rule = Rule' {}
- newRule :: Text -> Text -> Rule
- rule_columnSelectors :: Lens' Rule (Maybe (NonEmpty ColumnSelector))
- rule_disabled :: Lens' Rule (Maybe Bool)
- rule_substitutionMap :: Lens' Rule (Maybe (HashMap Text Text))
- rule_threshold :: Lens' Rule (Maybe Threshold)
- rule_name :: Lens' Rule Text
- rule_checkExpression :: Lens' Rule Text
Documentation
Represents a single data quality requirement that should be validated in the scope of this dataset.
See: newRule
smart constructor.
Rule' | |
|
Instances
Create a value of Rule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnSelectors:Rule'
, rule_columnSelectors
- 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.
$sel:disabled:Rule'
, rule_disabled
- 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.
$sel:substitutionMap:Rule'
, rule_substitutionMap
- 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`".
$sel:threshold:Rule'
, rule_threshold
- 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.
Rule
, rule_name
- The name of the rule.
$sel:checkExpression:Rule'
, rule_checkExpression
- 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
rule_columnSelectors :: Lens' Rule (Maybe (NonEmpty ColumnSelector)) Source #
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.
rule_disabled :: Lens' Rule (Maybe Bool) Source #
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.
rule_substitutionMap :: Lens' Rule (Maybe (HashMap Text Text)) Source #
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`".
rule_threshold :: Lens' Rule (Maybe Threshold) Source #
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.
rule_checkExpression :: Lens' Rule Text Source #
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