Expectation Gallery

This page provides comprehensive documentation for all available DataFrame expectations. The expectations are automatically categorized and organized for easy browsing.

Expectations Summary

Category	Subcategory	Expectations
Column Aggregation Expectations (11)	Any Value (2)	expect_max_null_countexpect_max_null_percentage
	Numerical (5)	expect_column_max_betweenexpect_column_mean_betweenexpect_column_median_betweenexpect_column_min_betweenexpect_column_quantile_between
	Unique (4)	expect_distinct_column_values_betweenexpect_distinct_column_values_equalsexpect_distinct_column_values_greater_thanexpect_distinct_column_values_less_than
Column Expectations (17)	Any Value (6)	expect_value_equalsexpect_value_inexpect_value_not_equalsexpect_value_not_inexpect_value_not_nullexpect_value_null
	Numerical (3)	expect_value_betweenexpect_value_greater_thanexpect_value_less_than
	String (8)	expect_string_containsexpect_string_ends_withexpect_string_length_betweenexpect_string_length_equalsexpect_string_length_greater_thanexpect_string_length_less_thanexpect_string_not_containsexpect_string_starts_with
DataFrame Aggregation Expectations (3)	Any Value (2)	expect_max_rowsexpect_min_rows
	Unique (1)	expect_unique_rows

Column Aggregation Expectations

Any Value

expect_max_null_count

Check if the count of null/NaN values in a specific column is below a threshold

Column Aggregation ExpectationsAny Value

Parameters:

column_name, max_count

expect_max_null_percentage

Check if the percentage of null/NaN values in a specific column is below a threshold

Column Aggregation ExpectationsAny Value

Parameters:

column_name, max_percentage

Numerical

expect_column_max_between

Check if the maximum value of a numeric column falls within a specified range

Column Aggregation ExpectationsNumerical

Parameters:

column_name, min_value, max_value

expect_column_mean_between

Check if the mean (average) of a numeric column falls within a specified range

Column Aggregation ExpectationsNumerical

Parameters:

column_name, min_value, max_value

expect_column_median_between

Check if the median of a numeric column falls within a specified range

Column Aggregation ExpectationsNumerical

Parameters:

column_name, min_value, max_value

expect_column_min_between

Check if the minimum value of a numeric column falls within a specified range

Column Aggregation ExpectationsNumerical

Parameters:

column_name, min_value, max_value

expect_column_quantile_between

Check if a specific quantile of a numeric column falls within a specified range

Column Aggregation ExpectationsNumerical

Parameters:

column_name, quantile, min_value, … (+1 more)

Unique

expect_distinct_column_values_between

Check if a column has a number of distinct values within a specified range

Column Aggregation ExpectationsUnique

Parameters:

column_name, min_value, max_value

expect_distinct_column_values_equals

Check if a column has exactly a specified number of distinct values

Column Aggregation ExpectationsUnique

Parameters:

column_name, expected_value

expect_distinct_column_values_greater_than

Check if a column has at least a specified number of distinct values

Column Aggregation ExpectationsUnique

Parameters:

column_name, threshold

expect_distinct_column_values_less_than

Check if a column has at most a specified number of distinct values

Column Aggregation ExpectationsUnique

Parameters:

column_name, threshold

Column Expectations

Any Value

expect_value_equals

Check if the values in a column equal a specified value

Column ExpectationsAny Value

Parameters:

column_name, value

expect_value_in

Check if the values in a column are in a specified list of values

Column ExpectationsAny Value

Parameters:

column_name, values

expect_value_not_equals

Check if the values in a column do not equal a specified value

Column ExpectationsAny Value

Parameters:

column_name, value

expect_value_not_in

Check if the values in a column are not in a specified list of values

Column ExpectationsAny Value

Parameters:

column_name, values

expect_value_not_null

Check if the values in a column are not null

Column ExpectationsAny Value

Parameters:

column_name

expect_value_null

Check if the values in a column are null

Column ExpectationsAny Value

Parameters:

column_name

Numerical

expect_value_between

Check if the values in a column are between two specified values

Column ExpectationsNumerical

Parameters:

column_name, min_value, max_value

expect_value_greater_than

Check if the values in a column are greater than a specified value

Column ExpectationsNumerical

Parameters:

column_name, value

expect_value_less_than

Check if the values in a column are less than a specified value

Column ExpectationsNumerical

Parameters:

column_name, value

String

expect_string_contains

Check if the values in a string column contain a specified substring

Column ExpectationsString

Parameters:

column_name, substring

expect_string_ends_with

Check if the values in a string column end with a specified suffix

Column ExpectationsString

Parameters:

column_name, suffix

expect_string_length_between

Check if the length of the values in a string column is between two specified lengths

Column ExpectationsString

Parameters:

column_name, min_length, max_length

expect_string_length_equals

Check if the length of the values in a string column equals a specified length

Column ExpectationsString

Parameters:

column_name, length

expect_string_length_greater_than

Check if the length of the values in a string column is greater than a specified length

Column ExpectationsString

Parameters:

column_name, length

expect_string_length_less_than

Check if the length of the values in a string column is less than a specified length

Column ExpectationsString

Parameters:

column_name, length

expect_string_not_contains

Check if the values in a string column do not contain a specified substring

Column ExpectationsString

Parameters:

column_name, substring

expect_string_starts_with

Check if the values in a string column start with a specified prefix

Column ExpectationsString

Parameters:

column_name, prefix

DataFrame Aggregation Expectations

Any Value

expect_max_rows

Check if the DataFrame has at most a maximum number of rows

DataFrame Aggregation ExpectationsAny Value

Parameters:

max_rows

expect_min_rows

Check if the DataFrame has at least a minimum number of rows

DataFrame Aggregation ExpectationsAny Value

Parameters:

min_rows

Unique

expect_unique_rows

Check if all rows in the DataFrame are unique based on specified columns

DataFrame Aggregation ExpectationsUnique

Parameters:

column_names