icydb-core 0.198.1

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
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! Module: db::query::intent::key_access
//! Responsibility: typed primary-key access hints owned by query intent.
//! Does not own: full logical-plan validation or access-path execution.
//! Boundary: lowers key-only builder state into planner-owned access plans.

use crate::{
    db::access::{AccessPlan, normalize_access_plan_value},
    db::query::plan::{PrimaryKeyInputResourceSummary, primary_key_input_resource_from_value_list},
    traits::KeyValueCodec,
    value::Value,
};

///
/// KeyAccess
///
/// Primary-key-only access hints for query planning.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub(in crate::db::query) enum KeyAccess<K> {
    Single(K),
    Many(Vec<K>),
}

///
/// KeyAccessKind
///
/// Identifies which key-only builder set the access path.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(in crate::db::query) enum KeyAccessKind {
    Single,
    Many,
    Only,
}

///
/// KeyAccessState
///
/// Tracks key-only access plus its origin for intent validation.
///

#[derive(Clone, Debug, Eq, PartialEq)]
pub(in crate::db::query) struct KeyAccessState<K> {
    pub(in crate::db::query::intent) kind: KeyAccessKind,
    pub(in crate::db::query::intent) access: KeyAccess<K>,
}

///
/// KeyAccessPlanningProjection
///
/// Planner-facing key-access projection that keeps the normalized access path
/// and pre-canonicalization input resource facts from drifting apart.
///

pub(in crate::db::query) struct KeyAccessPlanningProjection {
    access_plan: AccessPlan<Value>,
    input_resource: Option<PrimaryKeyInputResourceSummary>,
}

impl KeyAccessPlanningProjection {
    #[must_use]
    pub(in crate::db::query) fn into_parts(
        self,
    ) -> (AccessPlan<Value>, Option<PrimaryKeyInputResourceSummary>) {
        (self.access_plan, self.input_resource)
    }
}

/// Build a model-level access plan for key-only intents.
pub(in crate::db::query) fn build_access_plan_from_keys<K>(
    access: &KeyAccess<K>,
) -> AccessPlan<Value>
where
    K: KeyValueCodec,
{
    // Phase 1: map typed keys into model-level Value access paths.
    let plan = match access {
        KeyAccess::Single(key) => AccessPlan::by_key(key.to_key_value()),
        KeyAccess::Many(keys) => {
            let mut values = Vec::with_capacity(keys.len());
            values.extend(keys.iter().map(KeyValueCodec::to_key_value));

            AccessPlan::by_keys(values)
        }
    };

    // Phase 2: canonicalize the access shape via the shared access boundary.
    normalize_access_plan_value(plan)
}

/// Build planner access plus raw input-work facts in one typed key pass.
pub(in crate::db::query) fn project_key_access_for_planning<K>(
    access: &KeyAccess<K>,
) -> KeyAccessPlanningProjection
where
    K: KeyValueCodec,
{
    let (plan, input_resource) = match access {
        KeyAccess::Single(key) => (AccessPlan::by_key(key.to_key_value()), None),
        KeyAccess::Many(keys) => {
            let mut values = Vec::with_capacity(keys.len());
            values.extend(keys.iter().map(KeyValueCodec::to_key_value));
            let input_resource = primary_key_input_resource_from_value_list(&values);

            (AccessPlan::by_keys(values), input_resource)
        }
    };

    KeyAccessPlanningProjection {
        access_plan: normalize_access_plan_value(plan),
        input_resource,
    }
}