vecstore 1.0.0

The perfect vector database - 100/100 score, embeddable, high-performance, production-ready with RAG toolkit
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
//! Migration Tools for Vector Database Import/Export
//!
//! Provides utilities to migrate data from popular vector databases
//! (Pinecone, Weaviate, Qdrant, ChromaDB, Milvus) into vecstore format.
//!
//! ## Supported Sources
//!
//! - **Pinecone**: Cloud vector database
//! - **Weaviate**: Open-source vector search engine
//! - **Qdrant**: High-performance vector database
//! - **ChromaDB**: Embedding database for LLM apps
//! - **Milvus**: Cloud-native vector database
//!
//! ## Export Formats
//!
//! - **JSONL**: JSON Lines (one JSON object per line)
//! - **CSV**: Comma-separated values
//! - **Parquet**: Columnar format (Apache Arrow)
//! - **NPY**: NumPy binary format
//!
//! ## Example
//!
//! ```no_run
//! use vecstore::migration::{Migrator, SourceDatabase};
//!
//! # fn main() -> anyhow::Result<()> {
//! let migrator = Migrator::new();
//!
//! // Import from Pinecone export
//! let records = migrator.import_from_jsonl("pinecone_export.jsonl")?;
//! println!("Imported {} records", records.len());
//!
//! // Convert to vecstore format
//! let mut store = vecstore::VecStore::open("my_vecstore.db")?;
//! for record in records {
//!     store.upsert(record.id, record.vector, record.metadata)?;
//! }
//! # Ok(())
//! # }
//! ```

use anyhow::{anyhow, Result};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::collections::HashMap;
use std::fs::File;
use std::io::{BufRead, BufReader, BufWriter, Write};
use std::path::Path;

/// Source database type
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum SourceDatabase {
    /// Pinecone cloud vector database
    Pinecone,
    /// Weaviate vector search engine
    Weaviate,
    /// Qdrant vector database
    Qdrant,
    /// ChromaDB embedding database
    ChromaDB,
    /// Milvus cloud-native vector database
    Milvus,
    /// Generic JSONL format
    Generic,
}

impl SourceDatabase {
    /// Get database name
    pub fn name(&self) -> &str {
        match self {
            SourceDatabase::Pinecone => "pinecone",
            SourceDatabase::Weaviate => "weaviate",
            SourceDatabase::Qdrant => "qdrant",
            SourceDatabase::ChromaDB => "chromadb",
            SourceDatabase::Milvus => "milvus",
            SourceDatabase::Generic => "generic",
        }
    }
}

/// Migration record (universal format)
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MigrationRecord {
    /// Unique identifier
    pub id: String,

    /// Vector embedding
    #[serde(rename = "vector", alias = "embedding", alias = "values")]
    pub vector: Vec<f32>,

    /// Metadata
    #[serde(default)]
    pub metadata: HashMap<String, Value>,

    /// Optional timestamp
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<i64>,
}

/// Pinecone-specific record format
#[derive(Debug, Clone, Serialize, Deserialize)]
struct PineconeRecord {
    id: String,
    values: Vec<f32>,
    #[serde(default)]
    metadata: HashMap<String, Value>,
}

/// Weaviate-specific record format
#[derive(Debug, Clone, Serialize, Deserialize)]
struct WeaviateRecord {
    id: String,
    vector: Vec<f32>,
    #[serde(default)]
    properties: HashMap<String, Value>,
}

/// Qdrant-specific record format
#[derive(Debug, Clone, Serialize, Deserialize)]
struct QdrantRecord {
    id: Value, // Can be string or number
    vector: Vec<f32>,
    #[serde(default)]
    payload: HashMap<String, Value>,
}

/// ChromaDB-specific record format
#[derive(Debug, Clone, Serialize, Deserialize)]
struct ChromaRecord {
    id: String,
    embedding: Vec<f32>,
    #[serde(default)]
    metadata: HashMap<String, Value>,
    #[serde(skip_serializing_if = "Option::is_none")]
    document: Option<String>,
}

/// Milvus-specific record format
#[derive(Debug, Clone, Serialize, Deserialize)]
struct MilvusRecord {
    #[serde(alias = "pk", alias = "id")]
    primary_key: Value,
    vector: Vec<f32>,
    #[serde(flatten)]
    fields: HashMap<String, Value>,
}

/// Migration statistics
#[derive(Debug, Clone, Default)]
pub struct MigrationStats {
    pub total_records: usize,
    pub successful: usize,
    pub failed: usize,
    pub skipped: usize,
    pub total_vectors: usize,
    pub avg_vector_dim: f32,
    pub errors: Vec<String>,
}

impl MigrationStats {
    /// Create new stats
    pub fn new() -> Self {
        Self::default()
    }

    /// Add successful record
    pub fn add_success(&mut self) {
        self.successful += 1;
    }

    /// Add failed record
    pub fn add_failure(&mut self, error: String) {
        self.failed += 1;
        self.errors.push(error);
    }

    /// Add skipped record
    pub fn add_skipped(&mut self) {
        self.skipped += 1;
    }

    /// Get success rate
    pub fn success_rate(&self) -> f32 {
        if self.total_records == 0 {
            0.0
        } else {
            self.successful as f32 / self.total_records as f32
        }
    }
}

/// Migrator for vector database imports
pub struct Migrator {
    /// Validation mode (strict vs lenient)
    strict_mode: bool,

    /// Maximum dimension allowed
    max_dimension: Option<usize>,

    /// Dimension normalization (auto-detect or enforce)
    enforce_dimension: Option<usize>,
}

impl Migrator {
    /// Create a new migrator
    pub fn new() -> Self {
        Self {
            strict_mode: false,
            max_dimension: None,
            enforce_dimension: None,
        }
    }

    /// Enable strict validation mode
    pub fn with_strict_mode(mut self) -> Self {
        self.strict_mode = true;
        self
    }

    /// Set maximum allowed dimension
    pub fn with_max_dimension(mut self, max_dim: usize) -> Self {
        self.max_dimension = Some(max_dim);
        self
    }

    /// Enforce specific dimension (pad or truncate)
    pub fn with_enforce_dimension(mut self, dim: usize) -> Self {
        self.enforce_dimension = Some(dim);
        self
    }

    /// Import records from JSONL file
    ///
    /// # Arguments
    /// * `path` - Path to JSONL file
    /// * `source` - Source database type (for format detection)
    pub fn import_from_jsonl(
        &self,
        path: impl AsRef<Path>,
        source: SourceDatabase,
    ) -> Result<(Vec<MigrationRecord>, MigrationStats)> {
        let file = File::open(path.as_ref())?;
        let reader = BufReader::new(file);

        let mut records = Vec::new();
        let mut stats = MigrationStats::new();

        for (line_num, line) in reader.lines().enumerate() {
            stats.total_records += 1;

            let line = match line {
                Ok(l) => l,
                Err(e) => {
                    stats.add_failure(format!("Line {}: Failed to read line: {}", line_num + 1, e));
                    continue;
                }
            };

            if line.trim().is_empty() {
                stats.add_skipped();
                continue;
            }

            match self.parse_record(&line, source) {
                Ok(record) => {
                    // Validate dimension
                    if let Some(max_dim) = self.max_dimension {
                        if record.vector.len() > max_dim {
                            stats.add_failure(format!(
                                "Line {}: Vector dimension {} exceeds maximum {}",
                                line_num + 1,
                                record.vector.len(),
                                max_dim
                            ));
                            continue;
                        }
                    }

                    // Enforce dimension if specified
                    let record = if let Some(target_dim) = self.enforce_dimension {
                        self.normalize_dimension(record, target_dim)
                    } else {
                        record
                    };

                    stats.total_vectors += record.vector.len();
                    records.push(record);
                    stats.add_success();
                }
                Err(e) => {
                    if self.strict_mode {
                        return Err(anyhow!("Line {}: {}", line_num + 1, e));
                    } else {
                        stats.add_failure(format!("Line {}: {}", line_num + 1, e));
                    }
                }
            }
        }

        // Calculate average dimension
        if !records.is_empty() {
            stats.avg_vector_dim = stats.total_vectors as f32 / records.len() as f32;
        }

        Ok((records, stats))
    }

    /// Parse a single record based on source database format
    fn parse_record(&self, line: &str, source: SourceDatabase) -> Result<MigrationRecord> {
        match source {
            SourceDatabase::Pinecone => {
                let record: PineconeRecord = serde_json::from_str(line)?;
                Ok(MigrationRecord {
                    id: record.id,
                    vector: record.values,
                    metadata: record.metadata,
                    timestamp: None,
                })
            }

            SourceDatabase::Weaviate => {
                let record: WeaviateRecord = serde_json::from_str(line)?;
                Ok(MigrationRecord {
                    id: record.id,
                    vector: record.vector,
                    metadata: record.properties,
                    timestamp: None,
                })
            }

            SourceDatabase::Qdrant => {
                let record: QdrantRecord = serde_json::from_str(line)?;
                let id = match record.id {
                    Value::String(s) => s,
                    Value::Number(n) => n.to_string(),
                    _ => return Err(anyhow!("Invalid Qdrant ID format")),
                };

                Ok(MigrationRecord {
                    id,
                    vector: record.vector,
                    metadata: record.payload,
                    timestamp: None,
                })
            }

            SourceDatabase::ChromaDB => {
                let record: ChromaRecord = serde_json::from_str(line)?;
                let mut metadata = record.metadata;

                // Add document to metadata if present
                if let Some(doc) = record.document {
                    metadata.insert("document".to_string(), Value::String(doc));
                }

                Ok(MigrationRecord {
                    id: record.id,
                    vector: record.embedding,
                    metadata,
                    timestamp: None,
                })
            }

            SourceDatabase::Milvus => {
                let record: MilvusRecord = serde_json::from_str(line)?;
                let id = match record.primary_key {
                    Value::String(s) => s,
                    Value::Number(n) => n.to_string(),
                    _ => return Err(anyhow!("Invalid Milvus primary key format")),
                };

                Ok(MigrationRecord {
                    id,
                    vector: record.vector,
                    metadata: record.fields,
                    timestamp: None,
                })
            }

            SourceDatabase::Generic => {
                // Try to parse as generic migration record
                serde_json::from_str(line)
                    .map_err(|e| anyhow!("Failed to parse generic record: {}", e))
            }
        }
    }

    /// Normalize vector dimension (pad with zeros or truncate)
    fn normalize_dimension(
        &self,
        mut record: MigrationRecord,
        target_dim: usize,
    ) -> MigrationRecord {
        let current_dim = record.vector.len();

        if current_dim < target_dim {
            // Pad with zeros
            record.vector.resize(target_dim, 0.0);
        } else if current_dim > target_dim {
            // Truncate
            record.vector.truncate(target_dim);
        }

        record
    }

    /// Export records to JSONL format
    pub fn export_to_jsonl(
        &self,
        records: &[MigrationRecord],
        path: impl AsRef<Path>,
    ) -> Result<()> {
        let file = File::create(path.as_ref())?;
        let mut writer = BufWriter::new(file);

        for record in records {
            let json = serde_json::to_string(record)?;
            writeln!(writer, "{}", json)?;
        }

        writer.flush()?;
        Ok(())
    }

    /// Export records to CSV format
    pub fn export_to_csv(&self, records: &[MigrationRecord], path: impl AsRef<Path>) -> Result<()> {
        if records.is_empty() {
            return Err(anyhow!("No records to export"));
        }

        let file = File::create(path.as_ref())?;
        let mut writer = BufWriter::new(file);

        // Write header
        let dim = records[0].vector.len();
        write!(writer, "id,")?;
        for i in 0..dim {
            write!(writer, "v{},", i)?;
        }
        writeln!(writer, "metadata")?;

        // Write data
        for record in records {
            write!(writer, "{},", record.id)?;
            for &val in &record.vector {
                write!(writer, "{},", val)?;
            }
            let metadata_json = serde_json::to_string(&record.metadata)?;
            writeln!(writer, "\"{}\"", metadata_json.replace("\"", "\"\""))?;
        }

        writer.flush()?;
        Ok(())
    }

    /// Import from CSV format
    pub fn import_from_csv(
        &self,
        path: impl AsRef<Path>,
    ) -> Result<(Vec<MigrationRecord>, MigrationStats)> {
        let file = File::open(path.as_ref())?;
        let reader = BufReader::new(file);

        let mut records = Vec::new();
        let mut stats = MigrationStats::new();
        let mut lines = reader.lines();

        // Read header
        let header = if let Some(Ok(h)) = lines.next() {
            h
        } else {
            return Err(anyhow!("Empty CSV file"));
        };

        let headers: Vec<&str> = header.split(',').collect();
        let vector_cols: usize = headers.iter().filter(|h| h.starts_with("v")).count();

        // Read data rows
        for (line_num, line) in lines.enumerate() {
            stats.total_records += 1;

            let line = match line {
                Ok(l) => l,
                Err(e) => {
                    stats.add_failure(format!("Line {}: Failed to read: {}", line_num + 2, e));
                    continue;
                }
            };

            let parts: Vec<&str> = line.split(',').collect();
            if parts.len() < vector_cols + 2 {
                stats.add_failure(format!("Line {}: Insufficient columns", line_num + 2));
                continue;
            }

            let id = parts[0].to_string();

            // Parse vector
            let mut vector = Vec::with_capacity(vector_cols);
            for i in 1..=vector_cols {
                match parts[i].parse::<f32>() {
                    Ok(v) => vector.push(v),
                    Err(e) => {
                        stats.add_failure(format!(
                            "Line {}: Invalid vector value: {}",
                            line_num + 2,
                            e
                        ));
                        continue;
                    }
                }
            }

            // Parse metadata
            let metadata_str = parts[vector_cols + 1]
                .trim_matches('"')
                .replace("\"\"", "\"");
            let metadata: HashMap<String, Value> =
                serde_json::from_str(&metadata_str).unwrap_or_default();

            let record = MigrationRecord {
                id,
                vector,
                metadata,
                timestamp: None,
            };

            stats.total_vectors += record.vector.len();
            records.push(record);
            stats.add_success();
        }

        if !records.is_empty() {
            stats.avg_vector_dim = stats.total_vectors as f32 / records.len() as f32;
        }

        Ok((records, stats))
    }
}

impl Default for Migrator {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Write;
    use tempfile::NamedTempFile;

    #[test]
    fn test_parse_pinecone_record() {
        let migrator = Migrator::new();

        let json = r#"{"id": "vec1", "values": [0.1, 0.2, 0.3], "metadata": {"source": "test"}}"#;
        let record = migrator
            .parse_record(json, SourceDatabase::Pinecone)
            .unwrap();

        assert_eq!(record.id, "vec1");
        assert_eq!(record.vector, vec![0.1, 0.2, 0.3]);
        assert_eq!(
            record.metadata.get("source"),
            Some(&Value::String("test".to_string()))
        );
    }

    #[test]
    fn test_parse_qdrant_record() {
        let migrator = Migrator::new();

        let json = r#"{"id": "vec1", "vector": [0.1, 0.2], "payload": {"type": "doc"}}"#;
        let record = migrator.parse_record(json, SourceDatabase::Qdrant).unwrap();

        assert_eq!(record.id, "vec1");
        assert_eq!(record.vector, vec![0.1, 0.2]);
    }

    #[test]
    fn test_dimension_normalization() {
        let migrator = Migrator::new().with_enforce_dimension(5);

        let mut record = MigrationRecord {
            id: "vec1".to_string(),
            vector: vec![0.1, 0.2, 0.3],
            metadata: HashMap::new(),
            timestamp: None,
        };

        record = migrator.normalize_dimension(record, 5);
        assert_eq!(record.vector.len(), 5);
        assert_eq!(record.vector, vec![0.1, 0.2, 0.3, 0.0, 0.0]);

        let mut record2 = MigrationRecord {
            id: "vec2".to_string(),
            vector: vec![0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7],
            metadata: HashMap::new(),
            timestamp: None,
        };

        record2 = migrator.normalize_dimension(record2, 5);
        assert_eq!(record2.vector.len(), 5);
        assert_eq!(record2.vector, vec![0.1, 0.2, 0.3, 0.4, 0.5]);
    }

    #[test]
    fn test_import_export_jsonl() {
        let migrator = Migrator::new();

        // Create test data
        let mut file = NamedTempFile::new().unwrap();
        writeln!(
            file,
            r#"{{"id": "vec1", "vector": [0.1, 0.2, 0.3], "metadata": {{}}}}"#
        )
        .unwrap();
        writeln!(
            file,
            r#"{{"id": "vec2", "vector": [0.4, 0.5, 0.6], "metadata": {{}}}}"#
        )
        .unwrap();
        file.flush().unwrap();

        // Import
        let (records, stats) = migrator
            .import_from_jsonl(file.path(), SourceDatabase::Generic)
            .unwrap();

        assert_eq!(records.len(), 2);
        assert_eq!(stats.successful, 2);
        assert_eq!(stats.total_records, 2);

        // Export
        let export_file = NamedTempFile::new().unwrap();
        migrator
            .export_to_jsonl(&records, export_file.path())
            .unwrap();

        // Re-import to verify
        let (records2, _) = migrator
            .import_from_jsonl(export_file.path(), SourceDatabase::Generic)
            .unwrap();

        assert_eq!(records2.len(), 2);
        assert_eq!(records2[0].id, "vec1");
        assert_eq!(records2[1].id, "vec2");
    }

    #[test]
    fn test_migration_stats() {
        let mut stats = MigrationStats::new();

        stats.total_records = 10;
        stats.add_success();
        stats.add_success();
        stats.add_success();
        stats.add_failure("Error 1".to_string());
        stats.add_skipped();

        assert_eq!(stats.successful, 3);
        assert_eq!(stats.failed, 1);
        assert_eq!(stats.skipped, 1);
        assert_eq!(stats.success_rate(), 0.3);
        assert_eq!(stats.errors.len(), 1);
    }

    #[test]
    fn test_strict_mode() {
        let migrator = Migrator::new().with_strict_mode();

        // Create test data with one invalid record
        let mut file = NamedTempFile::new().unwrap();
        writeln!(
            file,
            r#"{{"id": "vec1", "vector": [0.1, 0.2, 0.3], "metadata": {{}}}}"#
        )
        .unwrap();
        writeln!(file, r#"invalid json"#).unwrap();
        file.flush().unwrap();

        // Should fail in strict mode
        let result = migrator.import_from_jsonl(file.path(), SourceDatabase::Generic);
        assert!(result.is_err());
    }

    #[test]
    fn test_lenient_mode() {
        let migrator = Migrator::new(); // Default is lenient

        // Create test data with one invalid record
        let mut file = NamedTempFile::new().unwrap();
        writeln!(
            file,
            r#"{{"id": "vec1", "vector": [0.1, 0.2, 0.3], "metadata": {{}}}}"#
        )
        .unwrap();
        writeln!(file, r#"invalid json"#).unwrap();
        writeln!(
            file,
            r#"{{"id": "vec2", "vector": [0.4, 0.5, 0.6], "metadata": {{}}}}"#
        )
        .unwrap();
        file.flush().unwrap();

        // Should succeed in lenient mode, skipping invalid record
        let (records, stats) = migrator
            .import_from_jsonl(file.path(), SourceDatabase::Generic)
            .unwrap();

        assert_eq!(records.len(), 2);
        assert_eq!(stats.successful, 2);
        assert_eq!(stats.failed, 1);
        assert_eq!(stats.total_records, 3);
    }
}