great_expectations.expectations.core.expect_column_to_exist
¶
Module Contents¶
Classes¶
|
Expect the specified column to exist. |
-
class
great_expectations.expectations.core.expect_column_to_exist.
ExpectColumnToExist
(configuration: Optional[ExpectationConfiguration] = None)¶ Bases:
great_expectations.expectations.expectation.TableExpectation
Expect the specified column to exist.
expect_column_to_exist is a
expectation
, not acolumn_map_expectation
orcolumn_aggregate_expectation
.- Parameters
column (str) – The column name.
- Other Parameters
column_index (int or None) – If not None, checks the order of the columns. The expectation will fail if the column is not in location column_index (zero-indexed).
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.
-
metric_dependencies
= ['table.columns']¶
-
success_keys
= ['column', 'column_index']¶
-
domain_keys
= ['batch_id', 'table']¶
-
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)¶