vectrust-storage 0.1.4

Storage backends for the vectrust vector database
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
use async_trait::async_trait;
use std::path::{Path, PathBuf};
use tokio::fs;
use vectrust_core::*;
use uuid::Uuid;
use serde::{Serialize, Deserialize};

/// Legacy storage format compatible with existing vectra-enhanced indexes
pub struct LegacyStorage {
    path: PathBuf,
    index_name: String,
    cache: tokio::sync::RwLock<Option<LegacyIndexFile>>,
}

/// Exact format matching Node.js index.json structure
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LegacyIndexFile {
    pub version: u32,
    pub metadata_config: MetadataConfig,
    pub items: Vec<VectorItem>,
}

impl LegacyStorage {
    pub fn new(path: &Path, index_name: &str) -> Result<Self> {
        Ok(Self {
            path: path.to_path_buf(),
            index_name: index_name.to_string(),
            cache: tokio::sync::RwLock::new(None),
        })
    }

    async fn perform_vector_search(&self, items: &[VectorItem], query_vector: &[f32], top_k: usize) -> Result<Vec<QueryResult>> {
        let mut results = self.compute_similarity_scores(items, query_vector)?;

        // Sort by score descending and apply limit
        results.sort_by(|a, b| b.score.partial_cmp(&a.score).unwrap_or(std::cmp::Ordering::Equal));
        results.truncate(top_k);

        // Load external metadata for results
        self.load_results_metadata(&mut results).await?;

        Ok(results)
    }

    fn compute_similarity_scores(&self, items: &[VectorItem], query_vector: &[f32]) -> Result<Vec<QueryResult>> {
        let mut results = Vec::new();

        for item in items {
            if let Some(result) = Self::evaluate_item_similarity(item, query_vector) {
                results.push(result);
            }
        }

        Ok(results)
    }

    fn evaluate_item_similarity(item: &VectorItem, query_vector: &[f32]) -> Option<QueryResult> {
        // Skip deleted items
        if item.deleted {
            return None;
        }

        // Validate vector compatibility
        if !VectorOps::compatible_dimensions(query_vector, &item.vector) {
            return None;
        }

        // Calculate similarity using cosine similarity (legacy format default)
        let similarity = VectorOps::calculate_similarity(
            query_vector,
            &item.vector,
            &DistanceMetric::Cosine
        );

        // Only include valid similarities
        if similarity.is_finite() {
            Some(QueryResult {
                item: item.clone(),
                score: similarity,
            })
        } else {
            None
        }
    }

    async fn load_results_metadata(&self, results: &mut Vec<QueryResult>) -> Result<()> {
        for result in results {
            if let Some(external_metadata) = self.load_metadata(&result.item.id).await? {
                result.item.metadata = external_metadata;
            }
        }
        Ok(())
    }
    
    fn index_path(&self) -> PathBuf {
        self.path.join(&self.index_name)
    }
    
    async fn load_index(&self) -> Result<LegacyIndexFile> {
        // Check cache first
        {
            let cache = self.cache.read().await;
            if let Some(ref index) = *cache {
                return Ok(index.clone());
            }
        }
        
        // Load from disk
        let path = self.index_path();
        if !path.exists() {
            return Err(VectraError::IndexNotFound { 
                path: path.to_string_lossy().to_string() 
            });
        }
        
        let content = fs::read_to_string(&path).await?;
        let index: LegacyIndexFile = serde_json::from_str(&content)?;
        
        // Update cache
        {
            let mut cache = self.cache.write().await;
            *cache = Some(index.clone());
        }
        
        Ok(index)
    }
    
    async fn save_index(&self, index: &LegacyIndexFile) -> Result<()> {
        let path = self.index_path();
        
        // Ensure directory exists
        if let Some(parent) = path.parent() {
            fs::create_dir_all(parent).await?;
        }
        
        // Write atomically via temp file
        let temp_path = path.with_extension("tmp");
        let content = serde_json::to_string_pretty(index)?;
        fs::write(&temp_path, content).await?;
        fs::rename(&temp_path, &path).await?;
        
        // Update cache
        {
            let mut cache = self.cache.write().await;
            *cache = Some(index.clone());
        }
        
        Ok(())
    }
    
    async fn load_metadata(&self, id: &Uuid) -> Result<Option<serde_json::Value>> {
        let metadata_path = self.path.join(format!("{}.json", id));
        
        if !metadata_path.exists() {
            return Ok(None);
        }
        
        let content = fs::read_to_string(metadata_path).await?;
        let metadata: serde_json::Value = serde_json::from_str(&content)?;
        Ok(Some(metadata))
    }
    
    async fn save_metadata(&self, id: &Uuid, metadata: &serde_json::Value) -> Result<()> {
        let metadata_path = self.path.join(format!("{}.json", id));
        let content = serde_json::to_string_pretty(metadata)?;
        fs::write(metadata_path, content).await?;
        Ok(())
    }
    
    async fn delete_metadata(&self, id: &Uuid) -> Result<()> {
        let metadata_path = self.path.join(format!("{}.json", id));
        if metadata_path.exists() {
            fs::remove_file(metadata_path).await?;
        }
        Ok(())
    }
}

#[async_trait]
impl StorageBackend for LegacyStorage {
    async fn exists(&self) -> bool {
        self.index_path().exists()
    }
    
    async fn create_index(&mut self, config: &CreateIndexConfig) -> Result<()> {
        let index_path = self.index_path();
        
        if index_path.exists() && !config.delete_if_exists {
            return Err(VectraError::IndexAlreadyExists { 
                path: index_path.to_string_lossy().to_string() 
            });
        }
        
        let index = LegacyIndexFile {
            version: config.version,
            metadata_config: config.metadata_config.clone(),
            items: Vec::new(),
        };
        
        self.save_index(&index).await?;
        Ok(())
    }
    
    async fn get_item(&self, id: &Uuid) -> Result<Option<VectorItem>> {
        let index = self.load_index().await?;
        
        // Find item in index
        let item = index.items.iter().find(|item| &item.id == id);
        
        if let Some(mut item) = item.cloned() {
            // Load external metadata if present
            if let Some(external_metadata) = self.load_metadata(id).await? {
                item.metadata = external_metadata;
            }
            Ok(Some(item))
        } else {
            Ok(None)
        }
    }
    
    async fn insert_item(&mut self, item: &VectorItem) -> Result<()> {
        let mut index = self.load_index().await?;
        
        // Check if item already exists
        if index.items.iter().any(|existing| existing.id == item.id) {
            return Err(VectraError::Storage { 
                message: format!("Item with ID {} already exists", item.id) 
            });
        }
        
        // Handle large metadata (save externally if > 1KB)
        let mut item_to_store = item.clone();
        let metadata_size = serde_json::to_string(&item.metadata)?.len();
        
        if metadata_size > 1024 {
            // Save metadata externally
            self.save_metadata(&item.id, &item.metadata).await?;
            item_to_store.metadata = serde_json::Value::Object(serde_json::Map::new());
        }
        
        // Add to index
        index.items.push(item_to_store);
        self.save_index(&index).await?;
        
        Ok(())
    }
    
    async fn update_item(&mut self, item: &VectorItem) -> Result<()> {
        let mut index = self.load_index().await?;
        
        // Find and update item
        let position = index.items.iter().position(|existing| existing.id == item.id)
            .ok_or(VectraError::ItemNotFound)?;
        
        // Handle metadata storage
        let mut item_to_store = item.clone();
        let metadata_size = serde_json::to_string(&item.metadata)?.len();
        
        if metadata_size > 1024 {
            self.save_metadata(&item.id, &item.metadata).await?;
            item_to_store.metadata = serde_json::Value::Object(serde_json::Map::new());
        } else {
            // Remove external metadata file if it exists
            self.delete_metadata(&item.id).await?;
        }
        
        index.items[position] = item_to_store;
        self.save_index(&index).await?;
        
        Ok(())
    }
    
    async fn delete_item(&mut self, id: &Uuid) -> Result<()> {
        let mut index = self.load_index().await?;
        
        // Remove from index
        let original_len = index.items.len();
        index.items.retain(|item| &item.id != id);
        
        if index.items.len() == original_len {
            return Err(VectraError::ItemNotFound);
        }
        
        // Delete external metadata if exists
        self.delete_metadata(id).await?;
        
        self.save_index(&index).await?;
        Ok(())
    }
    
    async fn list_items(&self, options: Option<ListOptions>) -> Result<Vec<VectorItem>> {
        let index = self.load_index().await?;
        let mut items = index.items.clone();
        
        // Load external metadata for all items
        for item in &mut items {
            if let Some(external_metadata) = self.load_metadata(&item.id).await? {
                item.metadata = external_metadata;
            }
        }
        
        // Apply pagination if specified
        if let Some(opts) = options {
            let offset = opts.offset.unwrap_or(0);
            let limit = opts.limit.unwrap_or(items.len());
            
            if offset < items.len() {
                let end = std::cmp::min(offset + limit, items.len());
                items = items[offset..end].to_vec();
            } else {
                items.clear();
            }
        }
        
        Ok(items)
    }
    
    async fn query_items(&self, query: &Query) -> Result<Vec<QueryResult>> {
        let index = self.load_index().await?;

        if let Some(ref query_vector) = query.vector {
            let results = self.perform_vector_search(&index.items, query_vector, query.top_k).await?;
            Ok(results)
        } else if let Some(ref _text_query) = query.text {
            // Text-only search not implemented in legacy format
            // In a full implementation, this would use BM25 or similar
            Ok(Vec::new())
        } else {
            // No query criteria provided
            Ok(Vec::new())
        }
    }
    
    async fn begin_transaction(&mut self) -> Result<()> {
        // Legacy format doesn't support transactions
        Ok(())
    }
    
    async fn commit_transaction(&mut self) -> Result<()> {
        // Legacy format doesn't support transactions
        Ok(())
    }
    
    async fn rollback_transaction(&mut self) -> Result<()> {
        // Legacy format doesn't support transactions
        Ok(())
    }
    
    async fn delete_index(&mut self) -> Result<()> {
        let index_path = self.index_path();
        
        if index_path.exists() {
            // Remove index file
            fs::remove_file(&index_path).await?;
            
            // Remove all metadata files
            let mut dir = fs::read_dir(&self.path).await?;
            let mut metadata_files = Vec::new();
            
            while let Some(entry) = dir.next_entry().await? {
                let path = entry.path();
                if let Some(ext) = path.extension() {
                    if ext == "json" && path != index_path {
                        // Check if it's a UUID filename (metadata file)
                        if let Some(stem) = path.file_stem() {
                            if let Some(stem_str) = stem.to_str() {
                                if Uuid::parse_str(stem_str).is_ok() {
                                    metadata_files.push(path);
                                }
                            }
                        }
                    }
                }
            }
            
            // Delete metadata files
            for metadata_file in metadata_files {
                fs::remove_file(metadata_file).await?;
            }
        }
        
        // Clear cache
        {
            let mut cache = self.cache.write().await;
            *cache = None;
        }
        
        Ok(())
    }
    
    async fn get_stats(&self) -> Result<IndexStats> {
        if !self.exists().await {
            return Ok(IndexStats {
                items: 0,
                size: 0,
                dimensions: None,
                distance_metric: DistanceMetric::Cosine,
            });
        }
        
        let index = self.load_index().await?;
        let dimensions = index.items.first().map(|item| item.vector.len());
        
        // Calculate total size
        let index_size = fs::metadata(self.index_path()).await?.len();
        
        Ok(IndexStats {
            items: index.items.len(),
            size: index_size,
            dimensions,
            distance_metric: DistanceMetric::Cosine, // Legacy format always uses cosine
        })
    }
}