velesdb-core 5.1.0

High-performance vector database engine written in Rust
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

use crate::collection::Collection;
use crate::distance::DistanceMetric;
use crate::point::Point;
use std::path::PathBuf;
use tempfile::TempDir;

/// Creates a test collection with the given dimension and cosine metric.
///
/// Returns the `TempDir` guard (must be kept alive for the collection's
/// lifetime) and the newly created `Collection`.
pub fn setup_collection(dim: usize) -> (TempDir, Collection) {
    let dir = tempfile::tempdir().expect("test: tempdir creation");
    let col = Collection::create(PathBuf::from(dir.path()), dim, DistanceMetric::Cosine)
        .expect("test: collection creation");
    (dir, col)
}

/// Creates a test collection pre-populated with the given points.
///
/// Combines [`setup_collection`] with an immediate `upsert` call,
/// eliminating the two-step boilerplate common in test setup functions.
#[allow(dead_code)] // Available for future test adoption.
pub fn setup_collection_with_points(dim: usize, points: Vec<Point>) -> (TempDir, Collection) {
    let (dir, col) = setup_collection(dim);
    col.upsert(points).expect("test: upsert");
    (dir, col)
}

/// Creates a simple test point with no payload or sparse vectors.
#[allow(dead_code)] // Available for future test adoption.
pub fn make_point(id: u64, vector: Vec<f32>) -> Point {
    Point {
        id,
        vector,
        payload: None,
        sparse_vectors: None,
    }
}

/// Creates a test point with a JSON payload.
pub fn make_point_with_payload(id: u64, vector: Vec<f32>, payload: serde_json::Value) -> Point {
    Point {
        id,
        vector,
        payload: Some(payload),
        sparse_vectors: None,
    }
}