tsink 0.10.2

A lightweight embedded time-series database with a straightforward API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use crate::engine::query::TieredQueryPlan;
use crate::engine::segment::SegmentManifest;

use super::super::config::TieredStorageConfig;
use super::{PersistedSegmentTier, SegmentInventory, SegmentInventoryEntry};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(in crate::engine::storage_engine) struct RetentionTierPolicy {
    retention_cutoff: i64,
    hot_cutoff: Option<i64>,
    warm_cutoff: Option<i64>,
    tier_moves_enabled: bool,
}

impl RetentionTierPolicy {
    pub(in crate::engine::storage_engine) fn new(
        retention_cutoff: i64,
        recency_reference: Option<i64>,
        tiered_storage: Option<&TieredStorageConfig>,
    ) -> Self {
        let hot_cutoff = recency_reference
            .zip(tiered_storage)
            .map(|(reference, config)| reference.saturating_sub(config.hot_retention_window));
        let warm_cutoff = recency_reference
            .zip(tiered_storage)
            .map(|(reference, config)| reference.saturating_sub(config.warm_retention_window));
        Self {
            retention_cutoff,
            hot_cutoff,
            warm_cutoff,
            tier_moves_enabled: tiered_storage.is_some(),
        }
    }

    pub(in crate::engine::storage_engine) fn retention_cutoff(self) -> i64 {
        self.retention_cutoff
    }

    pub(in crate::engine::storage_engine) fn query_plan(
        self,
        start: i64,
        end: i64,
    ) -> TieredQueryPlan {
        TieredQueryPlan::from_cutoffs(start, end, self.hot_cutoff, self.warm_cutoff)
    }

    pub(in crate::engine::storage_engine) fn desired_tier_for_manifest(
        self,
        manifest: &SegmentManifest,
    ) -> Option<PersistedSegmentTier> {
        let Some(max_ts) = manifest.max_ts else {
            return Some(PersistedSegmentTier::Hot);
        };
        if max_ts < self.retention_cutoff {
            return None;
        }
        if self.warm_cutoff.is_some_and(|cutoff| max_ts < cutoff) {
            Some(PersistedSegmentTier::Cold)
        } else if self.hot_cutoff.is_some_and(|cutoff| max_ts < cutoff) {
            Some(PersistedSegmentTier::Warm)
        } else {
            Some(PersistedSegmentTier::Hot)
        }
    }

    pub(in crate::engine::storage_engine) fn requires_retention_rewrite(
        self,
        manifest: &SegmentManifest,
    ) -> bool {
        matches!(
            (manifest.min_ts, manifest.max_ts),
            (Some(min_ts), Some(max_ts))
                if min_ts < self.retention_cutoff && max_ts >= self.retention_cutoff
        )
    }

    pub(in crate::engine::storage_engine) fn post_flush_maintenance_plan(
        self,
        inventory: &SegmentInventory,
    ) -> PostFlushMaintenancePolicyPlan {
        let mut plan = PostFlushMaintenancePolicyPlan::default();

        for entry in inventory.entries() {
            let Some(desired_tier) = self.desired_tier_for_manifest(&entry.manifest) else {
                plan.expired_actions.push(entry.clone());
                continue;
            };

            if self.requires_retention_rewrite(&entry.manifest) {
                plan.rewrite_actions.push(entry.clone());
                continue;
            }

            if !self.tier_moves_enabled
                || desired_tier == PersistedSegmentTier::Hot
                || desired_tier <= entry.tier
            {
                continue;
            }

            plan.move_actions.push(SegmentTierMoveAction {
                entry: entry.clone(),
                target_tier: desired_tier,
            });
        }

        plan
    }
}

#[derive(Debug, Default, Clone)]
pub(in crate::engine::storage_engine) struct PostFlushMaintenancePolicyPlan {
    pub(in crate::engine::storage_engine) rewrite_actions: Vec<SegmentInventoryEntry>,
    pub(in crate::engine::storage_engine) move_actions: Vec<SegmentTierMoveAction>,
    pub(in crate::engine::storage_engine) expired_actions: Vec<SegmentInventoryEntry>,
}

impl PostFlushMaintenancePolicyPlan {
    pub(in crate::engine::storage_engine) fn is_empty(&self) -> bool {
        self.rewrite_actions.is_empty()
            && self.move_actions.is_empty()
            && self.expired_actions.is_empty()
    }
}

#[derive(Debug, Clone)]
pub(in crate::engine::storage_engine) struct SegmentTierMoveAction {
    pub(in crate::engine::storage_engine) entry: SegmentInventoryEntry,
    pub(in crate::engine::storage_engine) target_tier: PersistedSegmentTier,
}