great_expectations.expectations.core.expect_column_pair_values_a_to_be_greater_than_b

Module Contents

Classes

ExpectColumnPairValuesAToBeGreaterThanB(configuration: Optional[ExpectationConfiguration] = None)

Expect values in column A to be greater than column B.

class great_expectations.expectations.core.expect_column_pair_values_a_to_be_greater_than_b.ExpectColumnPairValuesAToBeGreaterThanB(configuration: Optional[ExpectationConfiguration] = None)

Bases: great_expectations.expectations.expectation.TableExpectation

Expect values in column A to be greater than column B.

Parameters
  • column_A (str) – The first column name

  • column_B (str) – The second column name

  • or_equal (boolean or None) – If True, then values can be equal, not strictly greater

Keyword Arguments
  • allow_cross_type_comparisons (boolean or None) – If True, allow comparisons between types (e.g. integer and string). Otherwise, attempting such comparisons will raise an exception.

  • ignore_row_if (str) – “both_values_are_missing”, “either_value_is_missing”, “neither

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. For more detail, see include_config.

  • 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

An ExpectationSuiteValidationResult

Exact fields vary depending on the values passed to result_format and include_config, catch_exceptions, and meta.

library_metadata
metric_dependencies = ['column_a_greater_than_b']
success_keys = ['column_A', 'column_B', 'ignore_row_if', 'parse_strings_as_datetimes', 'allow_cross_type_comparisons', 'or_equal']
default_kwarg_values
validate_configuration(self, configuration: Optional[ExpectationConfiguration])
classmethod _prescriptive_renderer(cls, configuration=None, result=None, language=None, runtime_configuration=None, **kwargs)