great_expectations.expectations.core.expect_table_columns_to_match_set

Module Contents

Classes

ExpectTableColumnsToMatchSet(configuration: Optional[ExpectationConfiguration] = None)

Expect the columns to exactly match an unordered set.

class great_expectations.expectations.core.expect_table_columns_to_match_set.ExpectTableColumnsToMatchSet(configuration: Optional[ExpectationConfiguration] = None)

Bases: great_expectations.expectations.expectation.TableExpectation

Expect the columns to exactly match an unordered set.

expect_table_columns_to_match_set is a expectation, not a column_map_expectation or column_aggregate_expectation.

Parameters
  • column_set (list of str) – The column names, in the correct order.

  • exact_match (boolean) – Whether the list of columns must exactly match the observed columns.

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 = ['table.columns']
success_keys = ['column_set', 'exact_match']
default_kwarg_values
validate_configuration(self, configuration: Optional[ExpectationConfiguration])

Validates that a configuration has been set, and sets a configuration if it has yet to be set. Ensures that necessary configuration arguments have been provided for the validation of the expectation.

Parameters

configuration (OPTIONAL[ExpectationConfiguration]) – An optional Expectation Configuration entry that will be used to configure the expectation

Returns

True if the configuration has been validated successfully. Otherwise, raises an exception

classmethod _prescriptive_renderer(cls, configuration=None, result=None, language=None, runtime_configuration=None, **kwargs)
_validate(self, configuration: ExpectationConfiguration, metrics: Dict, runtime_configuration: dict = None, execution_engine: ExecutionEngine = None)