great_expectations.checkpoint.toolkit

Module Contents

Functions

list_checkpoints(checkpoint_store: CheckpointStore, ge_cloud_mode: bool)

add_checkpoint(data_context: DataContext, checkpoint_store: CheckpointStore, checkpoint_store_name: str, ge_cloud_mode: bool, name: str, config_version: Optional[Union[int, float]] = None, template_name: Optional[str] = None, module_name: Optional[str] = None, class_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[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, site_names: Optional[Union[str, List[str]]] = None, slack_webhook: Optional[str] = None, notify_on: Optional[str] = None, notify_with: Optional[Union[str, List[str]]] = None, ge_cloud_id: Optional[str] = None, expectation_suite_ge_cloud_id: Optional[str] = None)

get_checkpoint(data_context: DataContext, checkpoint_store: CheckpointStore, name: Optional[str] = None, ge_cloud_id: Optional[str] = None)

delete_checkpoint(checkpoint_store: CheckpointStore, name: Optional[str] = None, ge_cloud_id: Optional[str] = None)

run_checkpoint(data_context: DataContext, checkpoint_store: CheckpointStore, checkpoint_name: Optional[str] = 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, run_id: Optional[Union[str, int, float]] = None, run_name: Optional[str] = None, run_time: Optional[datetime.datetime] = None, result_format: Optional[str] = None, ge_cloud_id: Optional[str] = None, expectation_suite_ge_cloud_id: Optional[str] = None, **kwargs)

Validate against a pre-defined Checkpoint. (Experimental)

default_checkpoints_exist(directory_path: str)

great_expectations.checkpoint.toolkit.list_checkpoints(checkpoint_store: CheckpointStore, ge_cloud_mode: bool) → List[str]
great_expectations.checkpoint.toolkit.add_checkpoint(data_context: DataContext, checkpoint_store: CheckpointStore, checkpoint_store_name: str, ge_cloud_mode: bool, name: str, config_version: Optional[Union[int, float]] = None, template_name: Optional[str] = None, module_name: Optional[str] = None, class_name: Optional[str] = None, run_name_template: Optional[str] = None, expectation_suite_name: Optional[str] = None, batch_request: Optional[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, site_names: Optional[Union[str, List[str]]] = None, slack_webhook: Optional[str] = None, notify_on: Optional[str] = None, notify_with: Optional[Union[str, List[str]]] = None, ge_cloud_id: Optional[str] = None, expectation_suite_ge_cloud_id: Optional[str] = None) → Union[Checkpoint, LegacyCheckpoint]
great_expectations.checkpoint.toolkit.get_checkpoint(data_context: DataContext, checkpoint_store: CheckpointStore, name: Optional[str] = None, ge_cloud_id: Optional[str] = None) → Union[Checkpoint, LegacyCheckpoint]
great_expectations.checkpoint.toolkit.delete_checkpoint(checkpoint_store: CheckpointStore, name: Optional[str] = None, ge_cloud_id: Optional[str] = None)
great_expectations.checkpoint.toolkit.run_checkpoint(data_context: DataContext, checkpoint_store: CheckpointStore, checkpoint_name: Optional[str] = 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, run_id: Optional[Union[str, int, float]] = None, run_name: Optional[str] = None, run_time: Optional[datetime.datetime] = None, result_format: Optional[str] = None, ge_cloud_id: Optional[str] = None, expectation_suite_ge_cloud_id: Optional[str] = None, **kwargs) → CheckpointResult

Validate against a pre-defined Checkpoint. (Experimental) :param data_context: DataContext for Checkpoint class instantiation purposes :param checkpoint_store: CheckpointStore for managing Checkpoint configurations :param checkpoint_name: The name of a Checkpoint defined via the CLI or by manually creating a yml file :param template_name: The name of a Checkpoint template to retrieve from the CheckpointStore :param run_name_template: The template to use for run_name :param expectation_suite_name: Expectation suite to be used by Checkpoint run :param batch_request: Batch request to be used by Checkpoint run :param action_list: List of actions to be performed by the Checkpoint :param evaluation_parameters: $parameter_name syntax references to be evaluated at runtime :param runtime_configuration: Runtime configuration override parameters :param validations: Validations to be performed by the Checkpoint run :param profilers: Profilers to be used by the Checkpoint run :param run_id: The run_id for the validation; if None, a default value will be used :param run_name: The run_name for the validation; if None, a default value will be used :param run_time: The date/time of the run :param result_format: One of several supported formatting directives for expectation validation results :param ge_cloud_id: Great Expectations Cloud id for the checkpoint :param expectation_suite_ge_cloud_id: Great Expectations Cloud id for the expectation suite :param **kwargs: Additional kwargs to pass to the validation operator

Returns

CheckpointResult

great_expectations.checkpoint.toolkit.default_checkpoints_exist(directory_path: str) → bool