icydb-core 0.167.2

IcyDB — A schema-first typed query engine and persistence runtime for Internet Computer canisters
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

//! Module: index::plan::delta
//! Responsibility: pure index membership deltas derived from row transitions.
//! Does not own: commit-op materialization, executor context wiring, or apply sequencing.
//! Boundary: index planning emits these deltas; commit preparation lowers them to store writes.

use crate::db::{index::IndexKey, key_taxonomy::PrimaryKeyValue};

///
/// IndexMutationPlan
///
/// Deterministic collection of per-index membership deltas derived from one
/// row transition. The plan is intentionally independent of commit markers
/// and prepared apply operations.
///

#[derive(Debug)]
pub(in crate::db) struct IndexMutationPlan {
    pub(in crate::db) groups: Vec<IndexDeltaGroup>,
}

impl IndexMutationPlan {
    /// Build one plan from already-derived per-index delta groups.
    pub(in crate::db) const fn new(groups: Vec<IndexDeltaGroup>) -> Self {
        Self { groups }
    }
}

///
/// IndexDeltaGroup
///
/// Delta group for a single index definition. Grouping preserves the existing
/// per-index planning boundary while keeping each membership change as an
/// index-owned delta rather than a commit-owned operation.
///

#[derive(Debug)]
pub(in crate::db) struct IndexDeltaGroup {
    pub(in crate::db) index_store: String,
    pub(in crate::db) deltas: Vec<IndexDelta>,
}

impl IndexDeltaGroup {
    /// Build one per-index delta group.
    #[must_use]
    pub(in crate::db) fn new(index_store: &str, deltas: Vec<IndexDelta>) -> Self {
        Self {
            index_store: index_store.to_string(),
            deltas,
        }
    }
}

///
/// IndexDelta
///
/// One row-identity presence change for one secondary index key. The delta
/// records only index-domain facts: which key owns the row identity, which row
/// primary key is affected, and whether that presence is inserted or removed.
///

#[derive(Debug)]
pub(in crate::db) enum IndexDelta {
    /// Remove one row identity from one index key.
    Remove(IndexMembershipDelta),
    /// Insert one row identity into one index key.
    Insert(IndexMembershipDelta),
}

impl IndexDelta {
    /// Build one removal membership delta.
    #[must_use]
    pub(in crate::db) const fn remove(key: IndexKey, primary_key: &PrimaryKeyValue) -> Self {
        Self::Remove(IndexMembershipDelta {
            key,
            primary_key: *primary_key,
        })
    }

    /// Build one insertion membership delta.
    #[must_use]
    pub(in crate::db) const fn insert(key: IndexKey, primary_key: &PrimaryKeyValue) -> Self {
        Self::Insert(IndexMembershipDelta {
            key,
            primary_key: *primary_key,
        })
    }
}

///
/// IndexMembershipDelta
///
/// Index-domain payload shared by insert and remove deltas. Commit preparation
/// reads this payload when it materializes raw index entries, but the payload
/// itself carries no commit-layer concepts.
///

#[derive(Debug)]
pub(in crate::db) struct IndexMembershipDelta {
    pub(in crate::db) key: IndexKey,
    pub(in crate::db) primary_key: PrimaryKeyValue,
}