Expect the column entries to be strings with length equal to the provided value.
expect_column_value_lengths_to_equal
This expectation level is PRODUCTION
Contributors:
@great_expectationsTags:
core expectation
column map expectation
Metrics:
column_values.nonnull.unexpected_count
column_values.value_length.equals.unexpected_count
table.row_count
column_values.value_length.equals.unexpected_values
Description
Expect the column entries to be strings with length equal to the provided value.
This expectation only works for string-type values. Invoking it on ints or floats will raise a TypeError.
expect_column_values_to_be_between is a Column Map Expectation.
Args:
- column (str): The column name.
- value (int or None): The expected value for a column entry length.
Keyword Args:
- 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.
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
