great_expectations.checkpoint.checkpoint
¶
Module Contents¶
Classes¶
|
BaseCheckpoint class is initialized from CheckpointConfig typed object and contains all functionality |
|
|
|
|
|
-
great_expectations.checkpoint.checkpoint.
logger
¶
-
class
great_expectations.checkpoint.checkpoint.
BaseCheckpoint
(checkpoint_config: CheckpointConfig, data_context: DataContext)¶ Bases:
great_expectations.core.config_peer.ConfigPeer
BaseCheckpoint class is initialized from CheckpointConfig typed object and contains all functionality in the form of interface methods (which can be overwritten by subclasses) and their reference implementation.
-
run
(self, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, run_id: Optional[Union[str, RunIdentifier]] = None, run_name: Optional[str] = None, run_time: Optional[Union[str, datetime.datetime]] = None, result_format: Optional[Union[str, dict]] = None, expectation_suite_ge_cloud_id: Optional[str] = None)¶
-
get_substituted_config
(self, runtime_kwargs: Optional[dict] = None)¶
-
_get_substituted_template
(self, source_config: dict)¶
-
_get_substituted_runtime_kwargs
(self, source_config: dict, runtime_kwargs: Optional[dict] = None)¶
-
_substitute_config_variables
(self, config: dict)¶
-
_run_validation
(self, substituted_runtime_config: dict, async_validation_operator_results: List[AsyncResult], async_executor: AsyncExecutor, result_format: Optional[dict], run_id: Optional[Union[str, RunIdentifier]], idx: Optional[int] = 0, validation_dict: Optional[dict] = None)¶
-
self_check
(self, pretty_print=True)¶
-
property
config
(self)¶
-
property
name
(self)¶
-
property
config_version
(self)¶
-
property
action_list
(self)¶
-
property
validations
(self)¶
-
property
ge_cloud_id
(self)¶
-
property
data_context
(self)¶
-
__repr__
(self)¶ Return repr(self).
-
-
class
great_expectations.checkpoint.checkpoint.
Checkpoint
(name: str, data_context: DataContext, config_version: Optional[Union[int, float]] = None, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, validation_operator_name: Optional[str] = None, batches: Optional[List[dict]] = None, ge_cloud_id: Optional[UUID] = None, expectation_suite_ge_cloud_id: Optional[UUID] = None)¶ Bases:
great_expectations.checkpoint.checkpoint.BaseCheckpoint
-
class
great_expectations.checkpoint.checkpoint.
LegacyCheckpoint
(name: str, data_context, validation_operator_name: Optional[str] = None, batches: Optional[List[dict]] = None)¶ Bases:
great_expectations.checkpoint.checkpoint.Checkpoint
LegacyCheckpoint - Notebook - How-to GuideRun a configured Checkpoint from a notebook.Maturity: Experimental (to-be-deprecated in favor of Checkpoint)Details:API Stability: to-be-deprecated in favor of CheckpointImplementation Completeness: CompleteUnit Test Coverage: Partial (“golden path”-focused tests; error checking tests need to be improved)Integration Infrastructure/Test Coverage: N/ADocumentation Completeness: CompleteBug Risk: LowLegacyCheckpoint - Command Line - How-to GuideRun a configured checkpoint from a command line in a Terminal shell.Maturity: Experimental (to-be-deprecated in favor of Checkpoint)Details:API Stability: to-be-deprecated in favor of CheckpointImplementation Completeness: CompleteUnit Test Coverage: CompleteIntegration Infrastructure/Test Coverage: N/ADocumentation Completeness: CompleteBug Risk: LowLegacyCheckpoint - Cron - How-to GuideUse the Unix crontab command to edit the cron file and add a line that will run Checkpoint as a scheduled task.Maturity: Experimental (to-be-deprecated in favor of Checkpoint)Details:API Stability: to-be-deprecated in favor of CheckpointImplementation Completeness: CompleteUnit Test Coverage: CompleteIntegration Infrastructure/Test Coverage: N/ADocumentation Completeness: CompleteBug Risk: LowLegacyCheckpoint - Airflow DAG - How-to GuideRunning a configured Checkpoint in Apache Airflow enables the triggering of data validation using an Expectation Suite directly within an Airflow DAG.Maturity: Beta (to-be-deprecated in favor of Checkpoint)Details:API Stability: to-be-deprecated in favor of CheckpointImplementation Completeness: Partial (no operator, but probably don’t need one)Unit Test Coverage: N/AIntegration Infrastructure/Test Coverage: MinimalDocumentation Completeness: Complete (pending how-to)Bug Risk: LowLegacyCheckpoint - Kedro - How-to GuideTODO: LegacyCheckpoint - Kedro DescriptionMaturity: Experimental (to-be-deprecated in favor of Checkpoint)Details:API Stability: to-be-deprecated in favor of CheckpointImplementation Completeness: UnknownUnit Test Coverage: UnknownIntegration Infrastructure/Test Coverage: UnknownDocumentation Completeness: Minimal (none)Bug Risk: UnknownLegacyCheckpoint - Prefect - How-to GuideTODO: LegacyCheckpoint - Prefect DescriptionMaturity: Experimental (to-be-deprecated in favor of Checkpoint)Details:API Stability: to-be-deprecated in favor of CheckpointImplementation Completeness: UnknownUnit Test Coverage: UnknownIntegration Infrastructure/Test Coverage: UnknownDocumentation Completeness: Minimal (none)Bug Risk: UnknownLegacyCheckpoint - DBT - How-to GuideTODO: LegacyCheckpoint - DBT DescriptionMaturity: Beta (to-be-deprecated in favor of Checkpoint)Details:API Stability: to-be-deprecated in favor of CheckpointImplementation Completeness: MinimalUnit Test Coverage: Minimal (none)Integration Infrastructure/Test Coverage: Minimal (none)Documentation Completeness: Minimal (none)Bug Risk: Low-
property
validation_operator_name
(self)¶
-
property
batches
(self)¶
-
_run_default_validation_operator
(self, assets_to_validate: List, run_id: Optional[Union[str, RunIdentifier]] = None, evaluation_parameters: Optional[dict] = None, run_name: Optional[str] = None, run_time: Optional[Union[str, datetime.datetime]] = None, result_format: Optional[Union[str, dict]] = None)¶
-
run
(self, run_id=None, evaluation_parameters=None, run_name=None, run_time=None, result_format=None, **kwargs)¶
-
_get_batches_to_validate
(self, batches)¶
-
property
-
class
great_expectations.checkpoint.checkpoint.
SimpleCheckpoint
(name: str, data_context, config_version: Optional[Union[int, float]] = None, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, ge_cloud_id: Optional[UUID] = None, site_names: Union[str, List[str]] = 'all', slack_webhook: Optional[str] = None, notify_on: str = 'all', notify_with: Union[str, List[str]] = 'all', expectation_suite_ge_cloud_id: Optional[str] = None, **kwargs)¶ Bases:
great_expectations.checkpoint.checkpoint.Checkpoint
-
_configurator_class
¶
-
run
(self, template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequest, RuntimeBatchRequest, dict]] = None, action_list: Optional[List[dict]] = None, evaluation_parameters: Optional[dict] = None, runtime_configuration: Optional[dict] = None, validations: Optional[List[dict]] = None, profilers: Optional[List[dict]] = None, run_id: Optional[Union[str, RunIdentifier]] = None, run_name: Optional[str] = None, run_time: Optional[Union[str, datetime.datetime]] = None, result_format: Optional[str] = None, site_names: Union[str, List[str]] = 'all', slack_webhook: Optional[str] = None, notify_on: str = 'all', notify_with: Union[str, List[str]] = 'all', expectation_suite_ge_cloud_id: Optional[str] = None)¶
-