Struct nebari::tree::VersionedTreeRoot

pub struct VersionedTreeRoot<EmbeddedIndex> where
    EmbeddedIndex: EmbeddedIndex,  {
    pub transaction_id: TransactionId,
    pub sequence: SequenceId,
    pub by_sequence_root: BTreeEntry<BySequenceIndex<EmbeddedIndex>, BySequenceStats>,
    pub by_id_root: BTreeEntry<VersionedByIdIndex<EmbeddedIndex>, ByIdStats<EmbeddedIndex::Reduced>>,
    /* private fields */
}

A versioned B-Tree root. This tree root internally uses two btrees, one to keep track of all writes using a unique “sequence” ID, and one that keeps track of all key-value pairs.

Fields

transaction_id: TransactionId

The transaction ID of the tree root. If this transaction ID isn’t present in the transaction log, this root should not be trusted.

sequence: SequenceId

The last sequence ID inside of this root.

by_sequence_root: BTreeEntry<BySequenceIndex<EmbeddedIndex>, BySequenceStats>

The by-sequence B-Tree.

by_id_root: BTreeEntry<VersionedByIdIndex<EmbeddedIndex>, ByIdStats<EmbeddedIndex::Reduced>>

The by-id B-Tree.

Trait Implementations

impl<EmbeddedIndex: Clone> Clone for VersionedTreeRoot<EmbeddedIndex> where
    EmbeddedIndex: EmbeddedIndex,
    EmbeddedIndex::Reduced: Clone,
    EmbeddedIndex::Indexer: Clone, 

fn clone(&self) -> VersionedTreeRoot<EmbeddedIndex>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<EmbeddedIndex: Debug> Debug for VersionedTreeRoot<EmbeddedIndex> where
    EmbeddedIndex: EmbeddedIndex,
    EmbeddedIndex::Reduced: Debug,
    EmbeddedIndex::Indexer: Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<EmbeddedIndex> Default for VersionedTreeRoot<EmbeddedIndex> where
    EmbeddedIndex: EmbeddedIndex + Clone + Debug + 'static,
    EmbeddedIndex::Indexer: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<EmbeddedIndex> Root for VersionedTreeRoot<EmbeddedIndex> where
    EmbeddedIndex: EmbeddedIndex + Clone + Debug + 'static, 

const HEADER: PageHeader

The unique header byte for this root.

type Index = VersionedByIdIndex<EmbeddedIndex>

The primary index type contained within this root.

type ReducedIndex = ByIdStats<EmbeddedIndex::Reduced>

The primary index type contained within this root.

type Reducer = ByIdIndexer<EmbeddedIndex::Indexer>

The reducer that reduces Indexes and re-reduces ReducedIndexes.

fn default_with(reducer: Self::Reducer) -> Self

Returns a new instance with the provided reducer.

fn reducer(&self) -> &Self::Reducer

Returns the instance’s reducer.

fn initialized(&self) -> bool

Returns true if the tree is initialized.

fn dirty(&self) -> bool

Returns true if the root needs to be saved.

fn initialize_default(&mut self)

Resets the state to the default, initialized state. After calling this, Self::initialized() will return true.

fn count(&self) -> u64

Returns the number of values contained in this tree, not including deleted records.

fn deserialize(
    bytes: ArcBytes<'_>,
    reducer: Self::Reducer
) -> Result<Self, Error>

Deserializes the root from bytes.

fn serialize(
    &mut self,
    paged_writer: &mut PagedWriter<'_>,
    output: &mut Vec<u8>
) -> Result<(), Error>

Serialize the root and return the bytes. Writes any additional data to paged_writer in the process of serialization.

fn transaction_id(&self) -> TransactionId

Returns the current transaction id.

fn modify(
    &mut self,
    modification: Modification<'_, ArcBytes<'static>, Self::Index>,
    writer: &mut PagedWriter<'_>,
    max_order: Option<usize>
) -> Result<Vec<ModificationResult<Self::Index>>, Error>

Modifies the tree. Returns a list of modified keys and their updated indexes, if the keys are still present.

fn get_multiple<'keys, KeyEvaluator, KeyReader, Keys>(
    &self,
    keys: &mut Keys,
    key_evaluator: &mut KeyEvaluator,
    key_reader: &mut KeyReader,
    file: &mut dyn File,
    vault: Option<&dyn AnyVault>,
    cache: Option<&ChunkCache>
) -> Result<(), Error> where
    KeyEvaluator: FnMut(&ArcBytes<'static>, &Self::Index) -> ScanEvaluation,
    KeyReader: FnMut(ArcBytes<'static>, ArcBytes<'static>, Self::Index) -> Result<(), Error>,
    Keys: Iterator<Item = &'keys [u8]>, 

Iterates over the tree looking for keys. keys must be sorted. key_evaluator is invoked for each key as it is found, allowing for decisions on how to handle each key. key_reader will be invoked for each key that is requested to be read, but it might be invoked at a later time and in a different order.

fn scan<'keys, CallerError: Display + Debug, NodeEvaluator, KeyRangeBounds, KeyEvaluator, ScanDataCallback>(
    &self,
    range: &'keys KeyRangeBounds,
    args: &mut ScanArgs<Self::Index, Self::ReducedIndex, CallerError, NodeEvaluator, KeyEvaluator, ScanDataCallback>,
    file: &mut dyn File,
    vault: Option<&dyn AnyVault>,
    cache: Option<&ChunkCache>
) -> Result<bool, AbortError<CallerError>> where
    NodeEvaluator: FnMut(&ArcBytes<'static>, &Self::ReducedIndex, usize) -> ScanEvaluation,
    KeyEvaluator: FnMut(&ArcBytes<'static>, &Self::Index) -> ScanEvaluation,
    KeyRangeBounds: RangeBounds<&'keys [u8]> + Debug + ?Sized,
    ScanDataCallback: FnMut(ArcBytes<'static>, &Self::Index, ArcBytes<'static>) -> Result<(), AbortError<CallerError>>, 

Scans the tree over range. args.key_evaluator is invoked for each key as it is found, allowing for decisions on how to handle each key. args.key_reader will be invoked for each key that is requested to be read, but it might be invoked at a later time and in a different order.

fn copy_data_to(
    &mut self,
    include_nodes: bool,
    file: &mut dyn File,
    copied_chunks: &mut HashMap<u64, u64>,
    writer: &mut PagedWriter<'_>,
    vault: Option<&dyn AnyVault>
) -> Result<(), Error>

Copies all data from file into writer, updating self with the new file positions.

fn tree<File: ManagedFile>(
    name: impl Into<Cow<'static, str>>
) -> TreeRoot<Self, File> where
    Self::Reducer: Default, 

Returns a reference to a named tree that contains this type of root.

fn tree_with_reducer<File: ManagedFile>(
    name: impl Into<Cow<'static, str>>,
    reducer: Self::Reducer
) -> TreeRoot<Self, File>

Returns a reference to a named tree that contains this type of root.