minimemory 3.0.0

Embedded vector database library for Rust - like SQLite for vectors
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
//! Filtros de metadata con operadores lógicos y soporte para dot notation.

use super::FilterOp;
use crate::types::{Metadata, MetadataValue};

/// Filtro de metadata con operadores lógicos.
///
/// Permite construir consultas complejas combinando condiciones simples
/// con operadores AND/OR.
///
/// # Ejemplo
///
/// ```rust
/// use minimemory::Filter;
///
/// // Filtro simple
/// let filter = Filter::eq("author", "Juan");
///
/// // Encadenamiento con AND
/// let filter = Filter::eq("category", "tech")
///     .and(Filter::gte("score", 0.5f64));
///
/// // Encadenamiento con OR
/// let filter = Filter::eq("status", "published")
///     .or(Filter::eq("status", "featured"));
///
/// // Múltiples filtros con all/any
/// let filter = Filter::all(vec![
///     Filter::eq("category", "tech"),
///     Filter::gte("score", 0.5f64),
/// ]);
///
/// // Dot notation para campos anidados
/// let filter = Filter::eq("author.name", "Juan");
/// ```
#[derive(Debug, Clone)]
pub enum Filter {
    /// Condición simple: campo + operador
    Condition { field: String, op: FilterOp },
    /// AND lógico: todas las condiciones deben cumplirse
    And(Vec<Filter>),
    /// OR lógico: al menos una condición debe cumplirse
    Or(Vec<Filter>),
    /// NOT lógico: invierte el resultado
    Not(Box<Filter>),
}

impl Filter {
    // ========== Constructores para operadores de igualdad ==========

    /// Crea un filtro de igualdad simple.
    ///
    /// # Ejemplo
    /// ```rust
    /// use minimemory::query::Filter;
    /// let filter = Filter::eq("author", "Juan");
    /// ```
    pub fn eq(field: impl Into<String>, value: impl Into<MetadataValue>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Eq(value.into()),
        }
    }

    /// Crea un filtro de desigualdad.
    pub fn ne(field: impl Into<String>, value: impl Into<MetadataValue>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Ne(value.into()),
        }
    }

    // ========== Constructores para comparaciones numéricas ==========

    /// Crea un filtro "mayor que".
    pub fn gt(field: impl Into<String>, value: impl Into<MetadataValue>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Gt(value.into()),
        }
    }

    /// Crea un filtro "mayor o igual que".
    pub fn gte(field: impl Into<String>, value: impl Into<MetadataValue>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Gte(value.into()),
        }
    }

    /// Crea un filtro "menor que".
    pub fn lt(field: impl Into<String>, value: impl Into<MetadataValue>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Lt(value.into()),
        }
    }

    /// Crea un filtro "menor o igual que".
    pub fn lte(field: impl Into<String>, value: impl Into<MetadataValue>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Lte(value.into()),
        }
    }

    /// Crea un filtro de rango (min <= x <= max).
    pub fn range(
        field: impl Into<String>,
        min: Option<impl Into<MetadataValue>>,
        max: Option<impl Into<MetadataValue>>,
    ) -> Self {
        let field = field.into();
        let mut conditions = Vec::new();

        if let Some(min_val) = min {
            conditions.push(Filter::Condition {
                field: field.clone(),
                op: FilterOp::Gte(min_val.into()),
            });
        }

        if let Some(max_val) = max {
            conditions.push(Filter::Condition {
                field: field.clone(),
                op: FilterOp::Lte(max_val.into()),
            });
        }

        match conditions.len() {
            0 => Filter::And(vec![]), // Always true
            1 => conditions.remove(0),
            _ => Filter::And(conditions),
        }
    }

    // ========== Constructores para listas ==========

    /// Crea un filtro "valor en lista".
    pub fn in_list(field: impl Into<String>, values: Vec<impl Into<MetadataValue>>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::In(values.into_iter().map(|v| v.into()).collect()),
        }
    }

    /// Crea un filtro "valor NO en lista".
    pub fn not_in_list(field: impl Into<String>, values: Vec<impl Into<MetadataValue>>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Nin(values.into_iter().map(|v| v.into()).collect()),
        }
    }

    // ========== Constructores para strings ==========

    /// Crea un filtro "campo contiene substring".
    pub fn contains(field: impl Into<String>, substr: impl Into<String>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Contains(substr.into()),
        }
    }

    /// Crea un filtro "campo empieza con".
    pub fn starts_with(field: impl Into<String>, prefix: impl Into<String>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::StartsWith(prefix.into()),
        }
    }

    /// Crea un filtro "campo termina con".
    pub fn ends_with(field: impl Into<String>, suffix: impl Into<String>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::EndsWith(suffix.into()),
        }
    }

    /// Crea un filtro de regex sobre un campo string.
    ///
    /// # Ejemplo
    ///
    /// ```rust
    /// use minimemory::Filter;
    ///
    /// // Matches strings starting with "Hello"
    /// Filter::regex("title", "^Hello");
    /// ```
    pub fn regex(field: impl Into<String>, pattern: impl Into<String>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Regex(pattern.into()),
        }
    }

    // ========== Constructores para existencia ==========

    /// Crea un filtro "campo existe".
    pub fn exists(field: impl Into<String>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Exists(true),
        }
    }

    /// Crea un filtro "campo no existe".
    pub fn not_exists(field: impl Into<String>) -> Self {
        Filter::Condition {
            field: field.into(),
            op: FilterOp::Exists(false),
        }
    }

    // ========== Combinadores lógicos ==========

    /// Niega un filtro.
    pub fn not(filter: Filter) -> Self {
        Filter::Not(Box::new(filter))
    }

    // ========== Métodos encadenables ==========

    /// Combina este filtro con otro usando AND.
    ///
    /// # Ejemplo
    /// ```rust
    /// use minimemory::Filter;
    /// let filter = Filter::eq("category", "tech")
    ///     .and(Filter::gt("score", 0.5f64));
    /// ```
    pub fn and(self, other: Filter) -> Self {
        match self {
            Filter::And(mut filters) => {
                filters.push(other);
                Filter::And(filters)
            }
            _ => Filter::And(vec![self, other]),
        }
    }

    /// Combina este filtro con otro usando OR.
    ///
    /// # Ejemplo
    /// ```rust
    /// use minimemory::Filter;
    /// let filter = Filter::eq("status", "published")
    ///     .or(Filter::eq("status", "featured"));
    /// ```
    pub fn or(self, other: Filter) -> Self {
        match self {
            Filter::Or(mut filters) => {
                filters.push(other);
                Filter::Or(filters)
            }
            _ => Filter::Or(vec![self, other]),
        }
    }

    /// Combina múltiples filtros con AND (versión estática).
    pub fn all(filters: Vec<Filter>) -> Self {
        Filter::And(filters)
    }

    /// Combina múltiples filtros con OR (versión estática).
    pub fn any(filters: Vec<Filter>) -> Self {
        Filter::Or(filters)
    }
}

/// Evaluador de filtros sobre metadata.
pub struct FilterEvaluator;

impl FilterEvaluator {
    /// Evalúa si un documento cumple el filtro.
    ///
    /// # Arguments
    /// * `filter` - El filtro a evaluar
    /// * `metadata` - La metadata del documento (puede ser None)
    ///
    /// # Returns
    /// `true` si el documento cumple el filtro.
    pub fn evaluate(filter: &Filter, metadata: Option<&Metadata>) -> bool {
        match filter {
            Filter::Condition { field, op } => {
                let value = Self::get_nested_value(metadata, field);
                op.evaluate(value)
            }
            Filter::And(filters) => filters.iter().all(|f| Self::evaluate(f, metadata)),
            Filter::Or(filters) => {
                if filters.is_empty() {
                    return true; // Empty OR is vacuously true
                }
                filters.iter().any(|f| Self::evaluate(f, metadata))
            }
            Filter::Not(filter) => !Self::evaluate(filter, metadata),
        }
    }

    /// Obtiene un valor anidado usando dot notation.
    ///
    /// Soporta:
    /// - Campos simples: "author"
    /// - Campos anidados: "author.name"
    /// - Índices de array: "tags.0"
    ///
    /// # Arguments
    /// * `metadata` - La metadata del documento
    /// * `path` - El path al valor (e.g., "author.name")
    fn get_nested_value<'a>(
        metadata: Option<&'a Metadata>,
        path: &str,
    ) -> Option<&'a MetadataValue> {
        let metadata = metadata?;
        let parts: Vec<&str> = path.split('.').collect();

        if parts.is_empty() {
            return None;
        }

        // Obtener el valor inicial
        let mut current: Option<&MetadataValue> = metadata.get(parts[0]);

        // Navegar por los campos anidados
        for part in &parts[1..] {
            current = match current? {
                MetadataValue::Map(map) => map.get(*part),
                MetadataValue::List(list) => {
                    // Intentar parsear como índice
                    part.parse::<usize>().ok().and_then(|idx| list.get(idx))
                }
                _ => None,
            };
        }

        current
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::collections::HashMap;

    fn create_test_metadata() -> Metadata {
        let mut meta = Metadata::new();
        meta.insert("title", "Test Document");
        meta.insert("score", 0.8f64);
        meta.insert("count", 42i64);
        meta.insert("published", true);
        meta.insert("category", "tech");
        meta
    }

    fn create_nested_metadata() -> Metadata {
        let mut author = HashMap::new();
        author.insert(
            "name".to_string(),
            MetadataValue::String("Juan".to_string()),
        );
        author.insert("age".to_string(), MetadataValue::Int(30));

        let mut meta = Metadata::new();
        meta.insert("title", "Nested Document");
        meta.fields
            .insert("author".to_string(), MetadataValue::Map(author));
        meta.fields.insert(
            "tags".to_string(),
            MetadataValue::List(vec![
                MetadataValue::String("rust".to_string()),
                MetadataValue::String("programming".to_string()),
            ]),
        );
        meta
    }

    #[test]
    fn test_simple_eq() {
        let meta = create_test_metadata();
        let filter = Filter::eq("category", "tech");
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::eq("category", "sports");
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_numeric_comparison() {
        let meta = create_test_metadata();

        let filter = Filter::gte("score", 0.5f64);
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::lt("score", 0.5f64);
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::gt("count", 40i64);
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_and_filter() {
        let meta = create_test_metadata();

        let filter = Filter::all(vec![
            Filter::eq("category", "tech"),
            Filter::gte("score", 0.5f64),
        ]);
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::all(vec![
            Filter::eq("category", "sports"), // Fails
            Filter::gte("score", 0.5f64),
        ]);
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_or_filter() {
        let meta = create_test_metadata();

        let filter = Filter::any(vec![
            Filter::eq("category", "sports"), // Fails
            Filter::eq("category", "tech"),   // Passes
        ]);
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::any(vec![
            Filter::eq("category", "sports"),
            Filter::eq("category", "news"),
        ]);
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_not_filter() {
        let meta = create_test_metadata();

        let filter = Filter::not(Filter::eq("category", "sports"));
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::not(Filter::eq("category", "tech"));
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_nested_dot_notation() {
        let meta = create_nested_metadata();

        // Access nested object
        let filter = Filter::eq("author.name", "Juan");
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::gt("author.age", 25i64);
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_array_index_access() {
        let meta = create_nested_metadata();

        // Access array element by index
        let filter = Filter::eq("tags.0", "rust");
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::eq("tags.1", "programming");
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_in_list() {
        let meta = create_test_metadata();

        let filter = Filter::in_list("category", vec!["tech", "science", "news"]);
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::in_list("category", vec!["sports", "entertainment"]);
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_contains() {
        let meta = create_test_metadata();

        let filter = Filter::contains("title", "Document");
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::contains("title", "missing");
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_exists() {
        let meta = create_test_metadata();

        let filter = Filter::exists("title");
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::exists("nonexistent");
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::not_exists("nonexistent");
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_range() {
        let meta = create_test_metadata();

        let filter = Filter::range("score", Some(0.5f64), Some(1.0f64));
        assert!(FilterEvaluator::evaluate(&filter, Some(&meta)));

        let filter = Filter::range("score", Some(0.9f64), Some(1.0f64));
        assert!(!FilterEvaluator::evaluate(&filter, Some(&meta)));
    }

    #[test]
    fn test_none_metadata() {
        let filter = Filter::eq("field", "value");
        assert!(!FilterEvaluator::evaluate(&filter, None));

        let filter = Filter::not_exists("field");
        assert!(FilterEvaluator::evaluate(&filter, None));
    }
}