uqa-storage 0.5.0

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

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

//! Collect the writes of a batch derived from another.

use uqa_core::memory::BudgetedVec;

use crate::mvcc::overlay::run::SpilledRunWriter;
use crate::mvcc::{PrivateRecordRevision, VersionResult};
use crate::read_control::StorageReadControl;

use super::{PreparedRecordCommit, PreparedRecordWrite};

enum Target {
    Resident(BudgetedVec<PreparedRecordWrite>),
    Spilled {
        writer: Box<SpilledRunWriter>,
        identity: PrivateRecordRevision,
    },
}

/// Collects the writes of a batch derived from another in the order of the batch it derives from: in memory for a batch in memory, and in a spilled run for a spilled batch, whose writes are ordered by key.
pub(in crate::mvcc) struct PreparedWritesBuilder {
    target: Target,
}

impl PreparedWritesBuilder {
    /// A builder for the writes derived from `original`.
    pub(in crate::mvcc) fn like(
        original: &PreparedRecordCommit,
        control: &StorageReadControl,
    ) -> VersionResult<Self> {
        let target = match &original.writes {
            super::writes::PreparedWrites::Resident(writes) => {
                let mut derived = BudgetedVec::new(control.memory());
                derived.reserve(writes.len())?;
                Target::Resident(derived)
            }
            super::writes::PreparedWrites::Spilled(run) => Target::Spilled {
                writer: Box::new(SpilledRunWriter::new(
                    run.len(),
                    run.entry_bytes(),
                    control.memory(),
                )?),
                identity: PrivateRecordRevision::allocate()?,
            },
        };
        Ok(Self { target })
    }

    pub(in crate::mvcc) fn push(
        &mut self,
        write: PreparedRecordWrite,
        control: &StorageReadControl,
    ) -> VersionResult<()> {
        match &mut self.target {
            Target::Resident(writes) => writes.push(write).map_err(Into::into),
            Target::Spilled { writer, identity } => writer.push(
                write.key(),
                write.expected(),
                write.kind(),
                *identity,
                write.value(),
                control,
            ),
        }
    }

    /// The derived batch, fingerprinted as any other.
    pub(in crate::mvcc) fn finish(
        self,
        control: &StorageReadControl,
    ) -> VersionResult<PreparedRecordCommit> {
        match self.target {
            Target::Resident(writes) => PreparedRecordCommit::from_unique_owned(writes, control),
            Target::Spilled { writer, .. } => match writer.finish()? {
                Some(run) => PreparedRecordCommit::from_spilled_run(run, control),
                None => PreparedRecordCommit::from_unique_owned(
                    BudgetedVec::new(control.memory()),
                    control,
                ),
            },
        }
    }
}