Expect the compound columns to be unique.
expect_compound_columns_to_be_unique
This expectation level is PRODUCTION
Contributors:
Tags:
core expectation
multi-column expectation
Metrics:
compound_columns.unique.unexpected_count
table.row_count
compound_columns.unique.filtered_row_count
compound_columns.unique.unexpected_values
Description
Expect the compound columns to be unique.
expect_compound_columns_to_be_unique is a Multicolumn Map Expectation.
Args:
- column_list (tuple or list): Set of columns to be checked
Keyword Args:
- ignore_row_if (str): "all_values_are_missing", "any_value_is_missing", "never"
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.
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