Struct PrunerCfg

pub struct PrunerCfg {
    pruning_threshold: Option<u64>,
    minimum_retention: Duration,
    target_retention: Duration,
    batch_size: u64,
    max_usage: u16,
    interval: Duration,
    incremental_vacuum_pages: u64,
    state_tables: Vec<String>,
}

Fields

pruning_threshold: Option<u64>

minimum_retention: Duration

target_retention: Duration

batch_size: u64

max_usage: u16

interval: Duration

incremental_vacuum_pages: u64

state_tables: Vec<String>

Implementations

impl PrunerCfg

pub fn new() -> Self

pub fn validate(&self) -> Result<()>

pub fn with_state_tables(self, state_tables: Vec<String>) -> Self

pub fn with_pruning_threshold(self, pruning_threshold: u64) -> Self

pub fn with_minimum_retention(self, minimum_retention: Duration) -> Self

pub fn with_target_retention(self, target_retention: Duration) -> Self

pub fn with_batch_size(self, batch_size: u64) -> Self

pub fn with_max_usage(self, max_usage: u16) -> Self

pub fn with_interval(self, interval: Duration) -> Self

pub fn with_incremental_vacuum_pages(self, pages: u64) -> Self

pub fn pruning_threshold(&self) -> Option<u64>

Disk space threshold (in bytes).

If the disk usage exceeds this threshold, pruning of data starts from the oldest data and continues until the disk usage falls below MAX_USAGE or until the oldest data is younger than MINIMUM_RETENTION`

pub fn minimum_retention(&self) -> Duration

Minimum data retention period

Data younger than this is never pruned, regardless of disk usage.

pub fn target_retention(&self) -> Duration

Target data retention period

This is the ideal period for which data should be retained data younger than this and older than MINIMUM_RETENTION may be pruned if disk usage exceeds the pruning_threshold.

pub fn batch_size(&self) -> u64

Number of blocks to remove in a single pruning operation.

pub fn max_usage(&self) -> u16

Maximum disk usage (in basis points).

Pruning stops once the disk usage falls below this value, even if some data older than the MINIMUM_RETENTION remains. Values range from 0 (0%) to 10000 (100%).

pub fn interval(&self) -> Duration

Pruning interval

pub fn incremental_vacuum_pages(&self) -> u64

pages to remove from freelist during SQLite vacuuming

pub fn state_tables(&self) -> Vec<String>

State tables to prune

Trait Implementations

impl Clone for PrunerCfg

fn clone(&self) -> PrunerCfg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrunerCfg

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PrunerCfg

fn default() -> Self

Returns the “default value” for a type.