vectradb-components 0.1.0

Production-grade vector database components 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
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
105
106
107
108

use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use thiserror::Error;

// Re-export commonly used types
pub use ndarray::{Array1, ArrayView1};

/// Vector database error types
#[derive(Error, Debug)]
pub enum VectraDBError {
    #[error("Vector dimension mismatch: expected {expected}, got {actual}")]
    DimensionMismatch { expected: usize, actual: usize },
    #[error("Vector not found: {id}")]
    VectorNotFound { id: String },
    #[error("Invalid vector data")]
    InvalidVector,
    #[error("Database error: {0}")]
    DatabaseError(#[from] anyhow::Error),
}

/// Vector metadata structure
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VectorMetadata {
    pub id: String,
    pub dimension: usize,
    pub created_at: u64,
    pub updated_at: u64,
    pub tags: HashMap<String, String>,
}

/// Vector document structure
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VectorDocument {
    pub metadata: VectorMetadata,
    pub data: Array1<f32>,
}

/// Vector similarity result
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SimilarityResult {
    pub id: String,
    pub score: f32,
    pub metadata: VectorMetadata,
}

/// Vector database trait for different implementations
pub trait VectorDatabase {
    /// Create a new vector in the database
    fn create_vector(
        &mut self,
        id: String,
        vector: Array1<f32>,
        tags: Option<HashMap<String, String>>,
    ) -> Result<(), VectraDBError>;

    /// Fetch a vector by ID
    fn get_vector(&self, id: &str) -> Result<VectorDocument, VectraDBError>;

    /// Update an existing vector
    fn update_vector(
        &mut self,
        id: &str,
        vector: Array1<f32>,
        tags: Option<HashMap<String, String>>,
    ) -> Result<(), VectraDBError>;

    /// Delete a vector by ID
    fn delete_vector(&mut self, id: &str) -> Result<(), VectraDBError>;

    /// Upsert (insert or update) a vector
    fn upsert_vector(
        &mut self,
        id: String,
        vector: Array1<f32>,
        tags: Option<HashMap<String, String>>,
    ) -> Result<(), VectraDBError>;

    /// Search for similar vectors
    fn search_similar(
        &self,
        query_vector: Array1<f32>,
        top_k: usize,
    ) -> Result<Vec<SimilarityResult>, VectraDBError>;

    /// Get all vector IDs
    fn list_vectors(&self) -> Result<Vec<String>, VectraDBError>;

    /// Get database statistics
    fn get_stats(&self) -> Result<DatabaseStats, VectraDBError>;
}

/// Database statistics
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DatabaseStats {
    pub total_vectors: usize,
    pub dimension: usize,
    pub memory_usage: u64,
}

// Module declarations
pub mod indexing;
pub mod similarity;
pub mod storage;
pub mod vector_operations;

// Re-export main functionality
pub use similarity::*;
pub use vector_operations::*;