icydb-core 0.144.13

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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! Module: executor::pipeline::runtime::attempt
//! Responsibility: route-attempt key-stream resolution and materialization orchestration.
//! Does not own: execution-input construction or route planning.
//! Boundary: executes one already-assembled `ExecutionInputs` snapshot.

use crate::{
    db::{
        executor::{
            ExecutionPlan, OrderedKeyStreamBox, ScalarContinuationContext,
            pipeline::{
                contracts::{
                    ExecutionInputs, KernelRowsExecutionAttempt, MaterializedExecutionAttempt,
                    MaterializedExecutionPayload, ResolvedExecutionKeyStream,
                },
                operators::decorate_resolved_execution_key_stream,
                runtime::ExecutionMaterializationContract,
            },
        },
        index::IndexCompilePolicy,
    },
    error::InternalError,
};

type MaterializedExecutionPayloadResult = (MaterializedExecutionPayload, usize, usize);

///
/// ExecutionAttemptKernel
///
/// ExecutionAttemptKernel owns route-attempt orchestration for one immutable
/// execution-input snapshot.
/// It keeps execution behavior in the runtime layer while `ExecutionInputs`
/// remains the data snapshot consumed by scalar and aggregate paths.
///

pub(in crate::db::executor) struct ExecutionAttemptKernel<'a> {
    pub(in crate::db::executor::pipeline::runtime) inputs: &'a ExecutionInputs<'a>,
}

impl<'a> ExecutionAttemptKernel<'a> {
    /// Build one route-attempt kernel over an already-assembled execution input snapshot.
    #[must_use]
    pub(in crate::db::executor) const fn new(inputs: &'a ExecutionInputs<'a>) -> Self {
        Self { inputs }
    }

    // Build the shared materialization contract once so the two outward
    // request shapes stay aligned on predicate/projection/retained-slot wiring.
    fn materialization_contract<'req>(
        &'req self,
        route_plan: &ExecutionPlan,
    ) -> ExecutionMaterializationContract<'req> {
        ExecutionMaterializationContract {
            plan: self.inputs.plan(),
            residual_filter_program: self.inputs.residual_filter_program(),
            scan_budget_hint: route_plan.scan_hints.load_scan_budget_hint,
            load_order_route_contract: route_plan.load_order_route_contract(),
            validate_projection: self.inputs.validate_projection(),
            retain_slot_rows: self.inputs.retain_slot_rows(),
            retained_slot_layout: self.inputs.retained_slot_layout(),
            prepared_projection_validation: self.inputs.prepared_projection_validation(),
        }
    }

    /// Materialize one resolved scalar key stream through the aligned
    /// row-collector or canonical page runtime lane owned by this route
    /// attempt kernel.
    pub(in crate::db::executor) fn materialize_resolved_execution_stream<'req>(
        &'req self,
        route_plan: &ExecutionPlan,
        continuation: &'req ScalarContinuationContext,
        key_stream: &'req mut OrderedKeyStreamBox,
    ) -> Result<MaterializedExecutionPayloadResult, InternalError> {
        self.materialization_contract(route_plan)
            .materialize_resolved_execution_stream(
                self.inputs.runtime(),
                self.inputs.emit_cursor(),
                self.inputs.consistency(),
                continuation,
                route_plan.direction(),
                key_stream,
            )
    }

    /// Resolve one execution key stream under the canonical DISTINCT
    /// decoration contract for this prepared execution-input boundary.
    pub(in crate::db::executor) fn resolve_execution_key_stream(
        &self,
        route_plan: &ExecutionPlan,
        predicate_compile_mode: IndexCompilePolicy,
    ) -> Result<ResolvedExecutionKeyStream, InternalError> {
        let resolved =
            self.resolve_execution_key_stream_without_distinct(route_plan, predicate_compile_mode)?;

        Ok(decorate_resolved_execution_key_stream(
            resolved,
            self.inputs.plan(),
            self.inputs.stream_bindings().direction(),
        ))
    }

    /// Materialize one route-plan candidate end to end from resolved key
    /// stream decoration through structural page materialization.
    pub(in crate::db::executor) fn materialize_route_attempt(
        &self,
        route_plan: &ExecutionPlan,
        continuation: &ScalarContinuationContext,
        predicate_compile_mode: IndexCompilePolicy,
    ) -> Result<MaterializedExecutionAttempt, InternalError> {
        let mut resolved = self.resolve_execution_key_stream(route_plan, predicate_compile_mode)?;
        let (payload, keys_scanned, post_access_rows) = self
            .materialize_resolved_execution_stream(
                route_plan,
                continuation,
                resolved.key_stream_mut(),
            )?;
        let rows_scanned = resolved.rows_scanned_override().unwrap_or(keys_scanned);

        Ok(MaterializedExecutionAttempt {
            payload,
            rows_scanned,
            post_access_rows,
            optimization: resolved.optimization(),
            index_predicate_applied: resolved.index_predicate_applied(),
            index_predicate_keys_rejected: resolved.index_predicate_keys_rejected(),
            distinct_keys_deduped: resolved.distinct_keys_deduped(),
        })
    }

    /// Materialize one route-plan candidate into post-access scalar kernel rows.
    pub(in crate::db::executor) fn materialize_route_attempt_kernel_rows(
        &self,
        route_plan: &ExecutionPlan,
        continuation: &ScalarContinuationContext,
        predicate_compile_mode: IndexCompilePolicy,
    ) -> Result<KernelRowsExecutionAttempt, InternalError> {
        let mut resolved = self.resolve_execution_key_stream(route_plan, predicate_compile_mode)?;
        let mut attempt = self
            .materialization_contract(route_plan)
            .materialize_resolved_execution_stream_to_kernel_rows(
                self.inputs.runtime(),
                self.inputs.consistency(),
                continuation,
                route_plan.direction(),
                resolved.key_stream_mut(),
            )?;
        attempt.rows_scanned = resolved
            .rows_scanned_override()
            .unwrap_or(attempt.rows_scanned);
        attempt.optimization = resolved.optimization();
        attempt.index_predicate_applied = resolved.index_predicate_applied();
        attempt.index_predicate_keys_rejected = resolved.index_predicate_keys_rejected();
        attempt.distinct_keys_deduped = resolved.distinct_keys_deduped();

        Ok(attempt)
    }
}