uqa-storage 0.4.5

Document store, inverted index, IVF/HNSW vectors, B-tree, R*Tree, catalog
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

//
// Unified Query Algebra
//
// Copyright (c) 2023-2026 Cognica, Inc.
//

//! Transfer admitted retained nodes and payloads; projection/counter scratch and duplicate keys are released.

use super::{
    DocId, FieldName, IndexedFieldMetadata, MemoryIndexState, MemoryReplacementPlan,
    StagedMemoryDocument, StorageBackendResult, StorageReadControl,
};
use crate::inverted_index::{MemoryDocument, MemoryPosting, PostingKey};
use uqa_core::memory::{MemoryError, OwnedMap};

pub(super) struct Charge {
    pub retained: usize,
    pub new_entries: usize,
}

impl Charge {
    fn keep(&mut self, bytes: usize) -> StorageBackendResult<()> {
        self.retained = self
            .retained
            .checked_add(bytes)
            .ok_or(MemoryError::SizeOverflow)?;
        Ok(())
    }

    fn entries<K, V>(&mut self, count: usize) -> StorageBackendResult<()> {
        let bytes = count
            .checked_mul(OwnedMap::<K, V>::entry_bytes())
            .ok_or(MemoryError::SizeOverflow)?;
        self.new_entries = self
            .new_entries
            .checked_add(bytes)
            .ok_or(MemoryError::SizeOverflow)?;
        self.keep(bytes)
    }
}

pub(super) fn new_document(
    state: &MemoryIndexState,
    staged: &StagedMemoryDocument,
    plan: &MemoryReplacementPlan,
    control: &StorageReadControl,
) -> StorageBackendResult<Charge> {
    let mut charge = Charge {
        retained: 0,
        new_entries: 0,
    };
    charge.entries::<DocId, MemoryDocument>(1)?;
    for field in staged.fields.keys() {
        control.check()?;
        charge.keep(OwnedMap::<FieldName, IndexedFieldMetadata>::entry_bytes())?;
        charge.keep(field.capacity())?;
    }
    charge.keep(
        staged
            .terms
            .capacity()
            .checked_mul(size_of::<PostingKey>())
            .ok_or(MemoryError::SizeOverflow)?,
    )?;
    for (field, term) in &staged.terms {
        control.check()?;
        charge.keep(field.capacity())?;
        charge.keep(term.allocated_bytes())?;
    }
    for (key, posting) in &staged.postings {
        control.check()?;
        charge.entries::<DocId, MemoryPosting>(1)?;
        charge.keep(
            usize::try_from(super::super::footprint::posting_buffers(posting))
                .map_err(|_| MemoryError::SizeOverflow)?,
        )?;
        if !state.index.contains_key(key) {
            charge.entries::<PostingKey, OwnedMap<DocId, MemoryPosting>>(1)?;
            charge.keep(key.0.capacity())?;
            charge.keep(key.1.allocated_bytes())?;
        }
    }
    for field in plan.field_counters.keys() {
        control.check()?;
        if !state.field_counters.contains_key(field) {
            charge.entries::<FieldName, super::super::MemoryFieldCounters>(1)?;
            charge.keep(field.capacity())?;
        }
    }
    Ok(charge)
}