icydb-core 0.161.7

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

//! Module: index::plan::read
//! Responsibility: abstract read view needed by forward-index delta derivation.
//! Does not own: store lookup, executor context wiring, or commit materialization.
//! Boundary: commit/executor adapters provide this view before invoking index planning.

use crate::{
    db::{
        data::{DecodedDataStoreKey, RawRow, StorageKey},
        index::{IndexEntryValue, IndexReadContract, RawIndexStoreKey},
    },
    error::InternalError,
    types::EntityTag,
};
use std::ops::Bound;

///
/// IndexPlanReadView
///
/// Abstract preflight reads needed while deriving forward-index deltas. This
/// port intentionally accepts reduced index contract facts instead of generated
/// index definitions so index planning remains independent of registry,
/// executor, and commit state.
///

pub(in crate::db) trait IndexPlanReadView {
    /// Return the primary row for `key`, or `None` when no row exists.
    fn read_primary_row(&self, key: &DecodedDataStoreKey) -> Result<Option<RawRow>, InternalError>;

    /// Return the raw entry for one index key, or `None` when no entry exists.
    fn read_index_entry(
        &self,
        index: IndexReadContract<'_>,
        key: &RawIndexStoreKey,
    ) -> Result<Option<IndexEntryValue>, InternalError>;

    /// Return up to `limit` structural primary-key values resolved from one raw
    /// index-key range.
    fn read_index_keys_in_raw_range(
        &self,
        entity_path: &'static str,
        entity_tag: EntityTag,
        index: IndexReadContract<'_>,
        bounds: (&Bound<RawIndexStoreKey>, &Bound<RawIndexStoreKey>),
        limit: usize,
    ) -> Result<Vec<StorageKey>, InternalError>;
}