Expect the column entries to be between a minimum value and a maximum value (inclusive).
expect_column_values_to_be_between
This expectation level is EXPERIMENTAL
Contributors:
Tags:
Metrics:
Description
Expect the column entries to be between a minimum value and a maximum value (inclusive).
expect_column_values_to_be_between is a Column Map Expectation
Args:
- column (str): The column name.
- min_value (comparable type or None): The minimum value for a column entry.
- max_value (comparable type or None): The maximum value for a column entry.
- strict_min (boolean): If True, values must be strictly larger than min_value, default=False
- strict_max (boolean): If True, values must be strictly smaller than max_value, default=False
Keyword Args:
- parse_strings_as_datetimes (boolean or None) : If True, parse min_value, max_value, and all non-null column values to datetimes before making comparisons.
- output_strftime_format (str or None): A valid strfime format for datetime output. Only used if parse_strings_as_datetimes=True.
- mostly (None or a float between 0 and 1): Successful if at least mostly fraction of values match the expectation. For more detail, see mostly.
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, and there is no minimum value checked.
- If max_value is None, then min_value is treated as a lower bound, and there is no maximum value checked.
See Also:
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