nodedb-lite 0.1.0

Embedded edge client for NodeDB — offline vector search, graph traversal, and CRDT sync
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

// SPDX-License-Identifier: Apache-2.0
//! Read-only `KvOp` arms: point lookup, scan, TTL peek, batch/field get.

use nodedb_types::{QualifiedCollection, RlsWriteCheck};

use crate::error::LiteError;
use crate::query::engine::LiteQueryEngine;
use crate::query::kv_ops;
use crate::storage::engine::StorageEngine;

use super::super::LitePhysicalFut;
use super::super::policy::deny_policy;

pub(super) fn get<'a, S: StorageEngine + 'a>(
    engine: &'a LiteQueryEngine<S>,
    collection: &QualifiedCollection,
    key: &[u8],
    rls_filters: &[u8],
    surrogate_ceiling: Option<u32>,
) -> Result<LitePhysicalFut<'a>, LiteError> {
    // Get carries no write-check slot: it never writes.
    deny_policy(
        "KvOp::Get",
        None,
        &[rls_filters],
        &RlsWriteCheck::NoPolicyApplies,
    )?;
    let col = collection.clone();
    let k = key.to_vec();
    Ok(Box::pin(async move {
        kv_ops::reads::kv_get(engine, col.as_str(), &k, surrogate_ceiling).await
    }))
}

pub(super) fn scan<'a, S: StorageEngine + 'a>(
    engine: &'a LiteQueryEngine<S>,
    collection: &QualifiedCollection,
    cursor: &[u8],
    count: usize,
    match_pattern: Option<&str>,
    surrogate_ceiling: Option<u32>,
) -> Result<LitePhysicalFut<'a>, LiteError> {
    let col = collection.clone();
    let cur = cursor.to_vec();
    let pattern = match_pattern.map(str::to_owned);
    Ok(Box::pin(async move {
        kv_ops::reads::kv_scan(
            engine,
            col.as_str(),
            &cur,
            count,
            pattern.as_deref(),
            surrogate_ceiling,
        )
        .await
    }))
}

pub(super) fn get_ttl<'a, S: StorageEngine + 'a>(
    engine: &'a LiteQueryEngine<S>,
    collection: &QualifiedCollection,
    key: &[u8],
) -> Result<LitePhysicalFut<'a>, LiteError> {
    let col = collection.clone();
    let k = key.to_vec();
    Ok(Box::pin(async move {
        kv_ops::reads::kv_get_ttl(engine, col.as_str(), &k).await
    }))
}

pub(super) fn batch_get<'a, S: StorageEngine + 'a>(
    engine: &'a LiteQueryEngine<S>,
    collection: &QualifiedCollection,
    keys: &[Vec<u8>],
    rls_filters: &[u8],
) -> Result<LitePhysicalFut<'a>, LiteError> {
    // BatchGet carries no write-check slot: it never writes.
    deny_policy(
        "KvOp::BatchGet",
        None,
        &[rls_filters],
        &RlsWriteCheck::NoPolicyApplies,
    )?;
    let col = collection.clone();
    let ks = keys.to_vec();
    Ok(Box::pin(async move {
        kv_ops::reads::kv_batch_get(engine, col.as_str(), &ks).await
    }))
}

pub(super) fn field_get<'a, S: StorageEngine + 'a>(
    engine: &'a LiteQueryEngine<S>,
    collection: &QualifiedCollection,
    key: &[u8],
    fields: &[String],
    rls_filters: &[u8],
) -> Result<LitePhysicalFut<'a>, LiteError> {
    // FieldGet carries no write-check slot: it never writes.
    deny_policy(
        "KvOp::FieldGet",
        None,
        &[rls_filters],
        &RlsWriteCheck::NoPolicyApplies,
    )?;
    let col = collection.clone();
    let k = key.to_vec();
    let flds = fields.to_vec();
    Ok(Box::pin(async move {
        kv_ops::reads::kv_field_get(engine, col.as_str(), &k, &flds).await
    }))
}

pub(super) fn materialize_scan<'a, S: StorageEngine + 'a>(
    engine: &'a LiteQueryEngine<S>,
    collection: &QualifiedCollection,
    cursor: &[u8],
    count: usize,
) -> Result<LitePhysicalFut<'a>, LiteError> {
    let col = collection.clone();
    let cur = cursor.to_vec();
    Ok(Box::pin(async move {
        kv_ops::reads::kv_materialize_scan(engine, col.as_str(), &cur, count, None).await
    }))
}