Skip to main content
Version: 1.3.7

CheckpointFactory

Signature

class great_expectations.core.factory.CheckpointFactory(store: CheckpointStore)

Responsible for basic CRUD operations on a Data Context's Checkpoints.

Methods

Signature

add(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint

Add a Checkpoint to the collection.

Parameters

NameDescription

checkpoint

Checkpoint to add

Raises

TypeDescription

DataContextError

if Checkpoint already exists

Signature

add_or_update(checkpoint: great_expectations.checkpoint.checkpoint.Checkpoint) → great_expectations.checkpoint.checkpoint.Checkpoint

Add or update a Checkpoint by name.

If a Checkpoint with the same name exists, overwrite it, otherwise create a new Checkpoint.

Parameters

NameDescription

checkpoint

Checkpoint to add or update

Signature

all() → Iterable[great_expectations.checkpoint.checkpoint.Checkpoint]

Get all Checkpoints.

Signature

delete(name: str)None

Delete a Checkpoint from the collection.

Parameters

NameDescription

name

The name of the Checkpoint to delete

Raises

TypeDescription

DataContextError

if Checkpoint doesn't exist

Signature

get(name: str) → great_expectations.checkpoint.checkpoint.Checkpoint

Get a Checkpoint from the collection by name.

Parameters

NameDescription

name

Name of Checkpoint to get

Raises

TypeDescription

DataContextError

when Checkpoint is not found.