Struct PrunerConfig 

pub struct PrunerConfig {
    pub retention_epochs: u64,
    pub interval_ms: u64,
    pub max_chunk_checkpoints: u64,
    pub max_checkpoints_per_tick: u64,
}

Pruning policy for the historical column families.

Retention is expressed in epochs, mirroring the validator’s perpetual-store pruner: the retention_epochs most-recent epochs (including the current one) are retained in full, and everything in older epochs becomes eligible for deletion. The resulting floor is additionally clamped so it never advances past the oldest in-memory snapshot, keeping point-in-time reads coherent even under an aggressively small retention.

The pruner advances the floor toward its target in chunks of at most max_chunk_checkpoints checkpoints, persisting the new watermark after each chunk so progress survives a restart. Each tick advances the floor by at most max_checkpoints_per_tick checkpoints so a large backlog drains across many ticks rather than one long blocking pass.

Only the historical CFs are pruned: the per-transaction (transactions, effects, events, tx_metadata_by_seq), per-checkpoint (checkpoint_summary, checkpoint_contents), digest-reverse-index (tx_seq_by_digest, checkpoint_seq_by_digest), superseded-objects-version, checkpoint-pinned object_version_by_checkpoint, and ledger-history bitmap CFs. The live-set-bounded indexes (object_by_owner, object_by_type, balance, package_versions) and the tiny epochs CF are never pruned.

Fields

retention_epochs: u64

Number of most-recent epochs to retain in full. Data in epochs older than this is eligible for pruning. Must be at least 1; the pruner refuses to start otherwise, since a value of 0 would prune the current epoch.

interval_ms: u64

How often the pruner wakes to recompute the target floor and advance toward it, in milliseconds.

max_chunk_checkpoints: u64

Maximum number of checkpoints whose data is deleted in a single write batch. Bounds the per-batch work (and the number of effects rows scanned for object/digest deletes) when a whole epoch ages out at once.

max_checkpoints_per_tick: u64

Maximum number of checkpoints whose history is pruned in a single tick. Bounds the per-tick (blocking) work so that a large backlog — for example when pruning is first enabled on an old database — drains across many ticks rather than one long pass that occupies a blocking thread for minutes. The floor still converges to its retention target over subsequent ticks; interval_ms and this bound together set the drain rate. Must be at least 1; the pruner refuses to start otherwise, since a value of 0 would never make progress.

Implementations

impl PrunerConfig

pub fn interval(&self) -> Duration

The pruner’s wake interval as a Duration.

Trait Implementations

impl Clone for PrunerConfig

fn clone(&self) -> PrunerConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for PrunerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PrunerConfig

where PrunerConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PrunerConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.