SimpleCheckpoint

class great_expectations.checkpoint.SimpleCheckpoint(name: str, data_context, config_version: int | float | None = 1.0, template_name: str | None = None, run_name_template: str | None = None, expectation_suite_name: str | None = None, batch_request: BatchRequestBase | FluentBatchRequest | dict | None = None, validator: Validator | None = None, action_list: Sequence[ActionDict] | None = None, evaluation_parameters: dict | None = None, runtime_configuration: dict | None = None, validations: list[CheckpointValidationConfig] | list[dict] | None = None, profilers: list[dict] | None = None, ge_cloud_id: str | None = None, site_names: str | list[str] = 'all', slack_webhook: str | None = None, notify_on: str = 'all', notify_with: str | list[str] = 'all', expectation_suite_ge_cloud_id: str | None = None, **kwargs)#

A SimpleCheckpoint provides a means to simplify the process of specifying a Checkpoint configuration.

It provides a basic set of actions - store Validation Result, store Evaluation Parameters, update Data Docs, and optionally, send a Slack notification - allowing you to omit an action_list from your configuration and at runtime.

Parameters:

• name – user-selected Checkpoint name (e.g. staging_tables).

• data_context – Data context that is associated with the current checkpoint.

• config_version – version number of the checkpoint configuration.

• template_name – the name of another checkpoint to use as a base template.

• run_name_template – a template to create run names, using environment variables and datetime-template syntax (e.g. %Y-%M-staging-$MY_ENV_VAR).

• expectation_suite_name – expectation suite associated with checkpoint.

• batch_request – batch request describing the batch of data to validate.

• action_list – a list of actions to perform after each batch is validated.

• evaluation_parameters – evaluation parameters to use in generating this checkpoint.

• runtime_configuration – runtime configuration to pass into the validator’s runtime configuration (e.g. result_format).

• validations – validations to be executed as part of checkpoint.

• profilers – profilers to use in generating this checkpoint.

• validation_operator_name –

  list of validation operators configured by the checkpoint.

  Deprecated since version 0.14.0.

• batches –

  list of batches for validation by checkpoint.

  Deprecated since version 0.14.0.

• ge_cloud_id –

  Great Expectations Cloud id for this checkpoint.

  New in version 0.13.33: Used in cloud deployments.

• site_names – a list of Data Docs site names to update as part of the update Data Docs action - defaults to all.

• slack_webhook – if provided, an action will be added that sends a Slack notification to the provided webhook.

• notify_on – used to define when a notification is fired, according to validation result outcome - all, failure, or success. Defaults to all.

• notify_with – a list of Data Docs site names for which to include a URL in any notifications - defaults to all.

• expectation_suite_ge_cloud_id –

  Great Expectations Cloud id associated with expectation suite.

  New in version 0.13.33: Used in cloud deployments.

• kwargs – additional keyword arguments.

run(template_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[Union[BatchRequestBase, FluentBatchRequest, dict]] = None, validator: Optional[Validator] = None, action_list: Optional[Sequence[ActionDict]] = 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) → CheckpointResult#

Validate against the current SimpleCheckpoint.

Arguments allow for override of the current SimpleCheckpoint configuration.

Parameters:

• template_name – The name of another checkpoint to use as a base template.

• run_name_template – A template to create run names, using environment variables and datetime-template syntax (e.g. “%Y-%M-staging-$MY_ENV_VAR”).

• expectation_suite_name – Expectation suite associated with checkpoint.

• batch_request – Batch request describing the batch of data to validate.

• validator – Validator objects, loaded with Batch data samples, can be supplied (in lieu of “batch_request”)

• action_list – A list of actions to perform after each batch is validated.

• evaluation_parameters – Evaluation parameters to use in generating this checkpoint.

• runtime_configuration – Runtime configuration to pass into the validator’s runtime configuration (e.g. result_format).

• validations – Validations to be executed as part of checkpoint.

• profilers – Profilers to use in generating this checkpoint.

• run_id – The run_id for the validation; if None, a default value will be used.

• run_name – The run_name for the validation; if None, a default value will be used.

• run_time – The date/time of the run.

• result_format – One of several supported formatting directives for expectation validation results

• site_names – a list of Data Docs site names to update as part of the update Data Docs action - defaults to all.

• slack_webhook – if provided, an action will be added that sends a Slack notification to the provided webhook.

• notify_on – used to define when a notification is fired, according to validation result outcome - all, failure, or success. Defaults to all.

• notify_with – a list of Data Docs site names for which to include a URL in any notifications - defaults to all.

• expectation_suite_ge_cloud_id –

  Great Expectations Cloud id for the expectation suite

  New in version 0.13.33: Used in cloud deployments.

Returns:

CheckpointResult