Struct AuthorityStorePruningConfig 

pub struct AuthorityStorePruningConfig {
    pub num_latest_epoch_dbs_to_retain: usize,
    pub num_epochs_to_retain: u64,
    pub periodic_compaction_threshold_days: Option<usize>,
    pub num_epochs_to_retain_for_checkpoints: Option<u64>,
    pub num_epochs_to_retain_for_indexes: Option<u64>,
}

Fields

num_latest_epoch_dbs_to_retain: usize

number of the latest epoch dbs to retain

num_epochs_to_retain: u64

Number of historic epochs of object versions to keep, on top of the epoch the node is in. Read through Self::num_epochs_to_retain. 0 — keep the epoch the node is in only (default). N — keep the epoch the node is in plus the N epochs before it. u64::MAX — keep every epoch’s bucket; object pruning is off.

periodic_compaction_threshold_days: Option<usize>

enables periodic background compaction for old SST files whose last modified time is older than periodic_compaction_threshold_days days. That ensures that all sst files eventually go through the compaction process

With the key absent files older than a day are compacted, an explicit null turns periodic compaction off, and a value sets the threshold in days.

num_epochs_to_retain_for_checkpoints: Option<u64>

Number of historic epochs of transactions, effects, events, and checkpoint data to keep, on top of the epoch the node is in. Controls transaction pruning. Read through Self::num_epochs_to_retain_for_checkpoints. 0 — refused by NodeConfig::validate. N — keep the epoch the node is in plus the N epochs before it. u64::MAX — keep every epoch’s bucket; transaction pruning is off. None — DEFAULT_NUM_EPOCHS_TO_RETAIN_FOR_CHECKPOINTS.

num_epochs_to_retain_for_indexes: Option<u64>

Number of historic epochs of RPC index history (the transaction and event lookups behind iotax_queryTransactionBlocks, iotax_queryEvents and their gRPC equivalents) to keep, on top of the epoch the node is in. Index tables for live objects are not affected. Read through Self::num_epochs_to_retain_for_indexes. 0 — keep the epoch the node is in only. N — keep the epoch the node is in plus the N epochs before it. u64::MAX — keep every epoch’s bucket; index pruning is off. None — follow num_epochs_to_retain_for_checkpoints.

Must not exceed num_epochs_to_retain_for_checkpoints; the node refuses to start otherwise.

Implementations

impl AuthorityStorePruningConfig

pub fn set_num_epochs_to_retain(&mut self, num_epochs_to_retain: u64)

pub fn set_num_epochs_to_retain_for_checkpoints( &mut self, num_epochs_to_retain: Option<u64>, )

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

Historic epochs of object versions to keep on top of the epoch the node is in, None when object pruning is off.

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

Historic epochs of transactions, effects, events and checkpoint data to keep on top of the epoch the node is in, None when transaction pruning is off. Unset is DEFAULT_NUM_EPOCHS_TO_RETAIN_FOR_CHECKPOINTS.

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

Historic epochs of RPC index history to keep on top of the epoch the node is in, None when index pruning is off. Unset follows the transaction retention.

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

Fails if the index retention exceeds the transaction retention, which would let iotax_queryTransactionBlocks return digests the node has already pruned.

Trait Implementations

impl Clone for AuthorityStorePruningConfig

fn clone(&self) -> AuthorityStorePruningConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthorityStorePruningConfig

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

Formats the value using the given formatter.

impl Default for AuthorityStorePruningConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthorityStorePruningConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthorityStorePruningConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.