Skip to main content

Module layout

Module layout 

Source
Expand description

Object-store checkpoint layout with UUID v7 identifiers. Object-store checkpoint layout for distributed checkpoints.

Defines the directory structure, manifest format, and path conventions for checkpoints stored in object stores (S3, GCS, Azure Blob, local FS).

§Directory Layout

checkpoints/
├── _latest                          # Pointer to latest manifest
├── {checkpoint_id}/
│   ├── manifest.json                # CheckpointManifestV2
│   ├── operators/
│   │   └── {operator_name}/
│   │       └── partition-{id}.snap  # Full state snapshot
│   │       └── partition-{id}.delta # Incremental delta
│   └── offsets/
│       └── {source_name}.json       # Source offset data
└── {checkpoint_id}/
    └── ...

§Checkpoint IDs

CheckpointId wraps a UUID v7, which is time-sortable. This means lexicographic sorting of checkpoint directories equals chronological ordering — no need to parse timestamps or sequence numbers.

Structs§

CheckpointId
A time-sortable checkpoint identifier based on UUID v7.
CheckpointManifestV2
V2 checkpoint manifest for distributed object-store checkpoints.
CheckpointPaths
Deterministic path generator for checkpoint artifacts in object stores.
OperatorSnapshotEntry
Per-operator snapshot metadata in a V2 manifest.
PartitionSnapshotEntry
Per-partition snapshot or delta entry.
SourceOffsetEntry
Per-source offset entry for exactly-once recovery.