I suggest renaming this to "Expectation Suites" or combining it with the Expectation Suites section under "Expectations"
A Great Expectations Expectation Suite enables you to perform Create, Read, Update, and Delete (CRUD) operations on a
Suite's Expectations without needing to re-run them. Each of the methods that support a CRUD operation relies on two
main parameters -
- expectation_configuration - an
ExpectationConfigurationobject that is used to determine whether and where this Expectation already exists within the Suite. It can be a complete or a partial ExpectationConfiguration.
- match_type - a string with the value of
runtimewhich determines the criteria used for matching:
domainchecks whether two Expectation Configurations apply to the same data. It results in the loosest match, and can use the least complete ExpectationConfiguration object. For example, for a column map Expectation,
domain_kwargswill include the Expectation_type, the column, and any row_conditions that may affect which rows are evaluated by the Expectation.
successcriteria are more exacting - in addition to the
domainkwargs, these include those kwargs used when evaluating the success of an Expectation, like
runtimeare the most specific - in addition to
success_kwargs, these include kwargs used for runtime configuration. Currently these include
To add an Expectation to a Suite, you can use
suite.add_Expectation( expectation_configuration, match_type, overwrite_existing)
- If a matching Expectation is not found on the Suite, this function will add the Expectation to the Suite.
- If a matching Expectation is found on the Suite,
add_expectationwill throw an error, unless
overwrite_existingis set to
True, in which case the found Expectation will be updated with
- If more than one Expectation is found, this will throw an error, and you will be prompted to be more specific with your matching criteria.
To remove an Expectation from a Suite, you can use
suite.remove_Expectation( expectation_configuration, match_type, remove_multiple_matches)
- If this finds one matching Expectation, it will remove it.
- If it finds more than one matching Expectation, it will throw an error, unless
remove_multiple_matchesis set to True, in which case it will remove all matching Expectations.
- If this finds no matching Expectations, it will throw an error.