qdrant-edge 0.7.1

A lightweight, in-process vector search engine designed for embedded devices, autonomous systems, and mobile agents.
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

use std::ops::Bound;

use crate::common::counter::hardware_counter::HardwareCounterCell;
use crate::common::types::PointOffsetType;

use super::Encodable;
use crate::segment::common::operation_error::OperationResult;
use crate::segment::index::field_index::histogram::Histogram;
use crate::segment::index::field_index::numeric_point::{Numericable, Point};
use crate::segment::index::field_index::stored_point_to_values::StoredValue;
use crate::segment::index::payload_config::StorageType;
use crate::segment::telemetry::PayloadIndexTelemetry;

/// Read-only operations supported by every numeric-index storage variant
/// ([`super::mutable_numeric_index::MutableNumericIndex`],
/// [`super::immutable_numeric_index::ImmutableNumericIndex`],
/// [`super::mmap_numeric_index::UniversalNumericIndex`]).
///
/// Signatures are unified across variants so the enum-level dispatcher in
/// [`NumericIndexInner`] can call them generically. Variants that don't
/// need `hw_counter` (`Mutable` / `Immutable`) accept and ignore it; the
/// storage-backed `Mmap` variant uses it to track payload-index IO.
///
/// [`NumericIndexInner`]: super::NumericIndexInner
pub trait NumericIndexRead<T: Encodable + Numericable + Default + StoredValue> {
    /// Hardware counter is used only by the mmap-backed variant; in-memory
    /// variants ignore it. Returns `false` if the mmap read fails (matches
    /// the legacy enum dispatcher behavior — see the FIXME on
    /// [`super::NumericIndexInner::check_values_any`]).
    fn check_values_any(
        &self,
        idx: PointOffsetType,
        check_fn: impl Fn(&T) -> bool,
        hw_counter: &HardwareCounterCell,
    ) -> bool;

    fn get_values(&self, idx: PointOffsetType) -> Option<Box<dyn Iterator<Item = T> + '_>>;

    fn values_count(&self, idx: PointOffsetType) -> Option<usize>;

    fn total_unique_values_count(&self) -> OperationResult<usize>;

    fn values_range<'a>(
        &'a self,
        start_bound: Bound<Point<T>>,
        end_bound: Bound<Point<T>>,
        hw_counter: &'a HardwareCounterCell,
    ) -> OperationResult<impl Iterator<Item = PointOffsetType> + 'a>;

    fn orderable_values_range(
        &self,
        start_bound: Bound<Point<T>>,
        end_bound: Bound<Point<T>>,
    ) -> OperationResult<impl DoubleEndedIterator<Item = (T, PointOffsetType)> + '_>;

    /// Number of `(value, point)` pairs in the given range.
    ///
    /// The default counts [`Self::values_range`]; variants with a
    /// precomputed sorted container (`Immutable` / `Mmap`) override it with
    /// an `O(log n)` boundary search.
    fn values_range_size(
        &self,
        start_bound: Bound<Point<T>>,
        end_bound: Bound<Point<T>>,
        hw_counter: &HardwareCounterCell,
    ) -> OperationResult<usize> {
        Ok(self
            .values_range(start_bound, end_bound, hw_counter)?
            .count())
    }

    fn get_histogram(&self) -> &Histogram<T>;

    fn get_points_count(&self) -> usize;

    fn get_max_values_per_point(&self) -> usize;

    fn storage_type(&self) -> StorageType;

    fn ram_usage_bytes(&self) -> usize;

    /// Per-variant telemetry tag (e.g. `"mutable_numeric"`, `"mmap_numeric"`).
    /// Used by the default [`Self::get_telemetry_data`] to fill the
    /// `index_type` field. Mirrors [`MapIndexRead::telemetry_index_type`][1].
    ///
    /// [1]: crate::index::field_index::map_index::read_ops::MapIndexRead::telemetry_index_type
    fn telemetry_index_type(&self) -> &'static str;

    // Default-method helpers derived from the required methods above.

    fn values_is_empty(&self, idx: PointOffsetType) -> bool {
        self.values_count(idx).unwrap_or(0) == 0
    }

    fn get_telemetry_data(&self) -> PayloadIndexTelemetry {
        PayloadIndexTelemetry {
            field_name: None,
            points_count: self.get_points_count(),
            points_values_count: self.get_histogram().get_total_count(),
            histogram_bucket_size: Some(self.get_histogram().current_bucket_size()),
            index_type: self.telemetry_index_type(),
        }
    }
}