Expect the column to sum to be between a minimum value and a maximum value.
expect_column_sum_to_be_between
This expectation level is EXPERIMENTAL
Description
Expect the column to sum to be between a minimum value and a maximum value.
expect_column_sum_to_be_between is a Column Aggregate Expectation.
Args:
- column (str): The column name
- min_value (comparable type or None): The minimal sum allowed.
- max_value (comparable type or None): The maximal sum allowed.
- strict_min (boolean): If True, the minimal sum must be strictly larger than min_value, default=False
- strict_max (boolean): If True, the maximal sum must be strictly smaller than max_value, default=False
Other Parameters:
- result_format (str or None): Which output mode to use: BOOLEAN_ONLY, BASIC, COMPLETE, or SUMMARY. For more detail, see result_format.
- include_config (boolean): If True, then include the expectation config as part of the result object.
- catch_exceptions (boolean or None): If True, then catch exceptions and include them as part of the result object. For more detail, see catch_exceptions.
- meta (dict or None): A JSON-serializable dictionary (nesting allowed) that will be included in the output without modification. For more detail, see meta.
Returns:
Exact fields vary depending on the values passed to result_format, include_config, catch_exceptions, and meta.
Notes:
- min_value and max_value are both inclusive unless strict_min or strict_max are set to True.
- If min_value is None, then max_value is treated as an upper bound
- If max_value is None, then min_value is treated as a lower bound
- observed_value field in the result object is customized for this expectation to be a list representing the actual column sum
Want to make your own Expectation or an improvement to this one?
We've put together some great how to guides (including videos) on how to create your own expectations in a flash!
You can see those resources here: Contributor Resources