datafold 0.1.55

A personal database for data sovereignty with AI-powered ingestion
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
//! Function registry for transform operations
//!
//! Defines traits for iterator and reducer functions and provides a global
//! registry mapping function names to their metadata and executors.

use std::collections::HashMap;
use std::sync::OnceLock;

use crate::schema::types::field::FieldValue;
use crate::transform::iterator_stack_typed::types::IterationItem;

/// Result type for iterator function execution
pub type IteratorResult = Vec<IterationItem>;

/// Result type for reducer function execution  
pub type ReducerResult = String;

/// Metadata about a registered function
#[derive(Clone, Debug)]
pub struct FunctionMetadata {
    pub name: String,
    pub function_type: FunctionType,
    pub description: String,
}

/// Type of function
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum FunctionType {
    Iterator,
    Reducer,
}

/// Result of executing an iterator function
#[derive(Clone, Debug)]
pub enum IteratorExecutionResult {
    /// Returns new iteration items (normal case)
    Items(Vec<IterationItem>),
    /// Returns text tokens (for split_by_word)
    TextTokens(Vec<String>),
}

/// Trait for iterator functions that expand items into multiple items
pub trait IteratorFunction: Send + Sync {
    /// Execute the iterator function on a single item
    fn execute(&self, item: &IterationItem) -> IteratorExecutionResult;

    /// Get metadata about this function
    fn metadata(&self) -> FunctionMetadata;
}

/// Trait for reducer functions that aggregate multiple items into one
pub trait ReducerFunction: Send + Sync {
    /// Execute the reducer function on a collection of items
    fn execute(&self, items: &[IterationItem]) -> ReducerResult;

    /// Get metadata about this function
    fn metadata(&self) -> FunctionMetadata;
}

/// Global function registry
pub struct FunctionRegistry {
    iterators: HashMap<String, Box<dyn IteratorFunction>>,
    reducers: HashMap<String, Box<dyn ReducerFunction>>,
}

impl FunctionRegistry {
    fn new() -> Self {
        let mut registry = Self {
            iterators: HashMap::new(),
            reducers: HashMap::new(),
        };
        registry.register_builtins();
        registry
    }

    /// Register all built-in functions
    fn register_builtins(&mut self) {
        // Register iterator functions
        self.register_iterator(Box::new(SplitByWordFunction));
        self.register_iterator(Box::new(SplitArrayFunction));

        // Register reducer functions
        self.register_reducer(Box::new(FirstReducer));
        self.register_reducer(Box::new(LastReducer));
        self.register_reducer(Box::new(CountReducer));
        self.register_reducer(Box::new(JoinReducer));
        self.register_reducer(Box::new(SumReducer));
        self.register_reducer(Box::new(AverageReducer));
        self.register_reducer(Box::new(MaxReducer));
        self.register_reducer(Box::new(MinReducer));
    }

    /// Register an iterator function
    pub fn register_iterator(&mut self, func: Box<dyn IteratorFunction>) {
        let name = func.metadata().name.clone();
        self.iterators.insert(name, func);
    }

    /// Register a reducer function
    pub fn register_reducer(&mut self, func: Box<dyn ReducerFunction>) {
        let name = func.metadata().name.clone();
        self.reducers.insert(name, func);
    }

    /// Get an iterator function by name
    pub fn get_iterator(&self, name: &str) -> Option<&dyn IteratorFunction> {
        self.iterators.get(name).map(|b| b.as_ref())
    }

    /// Get a reducer function by name
    pub fn get_reducer(&self, name: &str) -> Option<&dyn ReducerFunction> {
        self.reducers.get(name).map(|b| b.as_ref())
    }

    /// Check if a function name is registered as an iterator
    pub fn is_iterator(&self, name: &str) -> bool {
        self.iterators.contains_key(name)
    }

    /// Check if a function name is registered as a reducer
    pub fn is_reducer(&self, name: &str) -> bool {
        self.reducers.contains_key(name)
    }

    /// Check if a function name is registered (either type)
    pub fn is_registered(&self, name: &str) -> bool {
        self.is_iterator(name) || self.is_reducer(name)
    }

    /// Get the type of a registered function
    pub fn get_function_type(&self, name: &str) -> Option<FunctionType> {
        if self.is_iterator(name) {
            Some(FunctionType::Iterator)
        } else if self.is_reducer(name) {
            Some(FunctionType::Reducer)
        } else {
            None
        }
    }

    /// Get all registered iterator names
    pub fn iterator_names(&self) -> Vec<String> {
        self.iterators.keys().cloned().collect()
    }

    /// Get all registered reducer names
    pub fn reducer_names(&self) -> Vec<String> {
        self.reducers.keys().cloned().collect()
    }
}

/// Global registry instance
static REGISTRY: OnceLock<FunctionRegistry> = OnceLock::new();

/// Get the global function registry
pub fn registry() -> &'static FunctionRegistry {
    REGISTRY.get_or_init(FunctionRegistry::new)
}

// ============================================================================
// Built-in Iterator Functions
// ============================================================================

/// Split a text value into words
struct SplitByWordFunction;

impl IteratorFunction for SplitByWordFunction {
    fn execute(&self, item: &IterationItem) -> IteratorExecutionResult {
        let text = extract_text_value(&item.value);
        let words = split_words(&text);
        IteratorExecutionResult::TextTokens(words)
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "split_by_word".to_string(),
            function_type: FunctionType::Iterator,
            description: "Split text into individual words".to_string(),
        }
    }
}

/// Split an array into elements
struct SplitArrayFunction;

impl IteratorFunction for SplitArrayFunction {
    fn execute(&self, item: &IterationItem) -> IteratorExecutionResult {
        match &item.value.value {
            serde_json::Value::Array(arr) => {
                let items = arr
                    .iter()
                    .map(|val| {
                        let mut new_item = item.clone();
                        new_item.value.value = val.clone();
                        new_item
                    })
                    .collect();
                IteratorExecutionResult::Items(items)
            }
            _ => IteratorExecutionResult::Items(vec![item.clone()]),
        }
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "split_array".to_string(),
            function_type: FunctionType::Iterator,
            description: "Split an array into individual elements".to_string(),
        }
    }
}

// ============================================================================
// Built-in Reducer Functions
// ============================================================================

struct FirstReducer;

impl ReducerFunction for FirstReducer {
    fn execute(&self, items: &[IterationItem]) -> ReducerResult {
        sorted_items(items)
            .first()
            .map(|item| extract_text_value(&item.value))
            .unwrap_or_default()
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "first".to_string(),
            function_type: FunctionType::Reducer,
            description: "Return the first item".to_string(),
        }
    }
}

struct LastReducer;

impl ReducerFunction for LastReducer {
    fn execute(&self, items: &[IterationItem]) -> ReducerResult {
        sorted_items(items)
            .last()
            .map(|item| extract_text_value(&item.value))
            .unwrap_or_default()
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "last".to_string(),
            function_type: FunctionType::Reducer,
            description: "Return the last item".to_string(),
        }
    }
}

struct CountReducer;

impl ReducerFunction for CountReducer {
    fn execute(&self, items: &[IterationItem]) -> ReducerResult {
        items.len().to_string()
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "count".to_string(),
            function_type: FunctionType::Reducer,
            description: "Count the number of items".to_string(),
        }
    }
}

struct JoinReducer;

impl ReducerFunction for JoinReducer {
    fn execute(&self, items: &[IterationItem]) -> ReducerResult {
        sorted_items(items)
            .into_iter()
            .map(|item| extract_text_value(&item.value))
            .collect::<Vec<_>>()
            .join(", ")
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "join".to_string(),
            function_type: FunctionType::Reducer,
            description: "Join items into a comma-separated string".to_string(),
        }
    }
}

struct SumReducer;

impl ReducerFunction for SumReducer {
    fn execute(&self, items: &[IterationItem]) -> ReducerResult {
        let sum: f64 = items
            .iter()
            .filter_map(|item| match &item.value.value {
                serde_json::Value::Number(n) => n.as_f64(),
                _ => None,
            })
            .sum();
        if sum.abs() < f64::EPSILON {
            "0".to_string()
        } else {
            let mut value = sum.to_string();
            if value.ends_with(".0") {
                value.truncate(value.len() - 2);
            }
            value
        }
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "sum".to_string(),
            function_type: FunctionType::Reducer,
            description: "Sum numeric values".to_string(),
        }
    }
}

struct AverageReducer;

impl ReducerFunction for AverageReducer {
    fn execute(&self, items: &[IterationItem]) -> ReducerResult {
        let count = items.len();
        if count == 0 {
            return "0".to_string();
        }

        let sum: f64 = items
            .iter()
            .filter_map(|item| match &item.value.value {
                serde_json::Value::Number(n) => n.as_f64(),
                _ => None,
            })
            .sum();

        let avg = sum / count as f64;

        if avg.abs() < f64::EPSILON {
            "0".to_string()
        } else {
            let mut value = avg.to_string();
            if value.ends_with(".0") {
                value.truncate(value.len() - 2);
            }
            value
        }
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "average".to_string(),
            function_type: FunctionType::Reducer,
            description: "Calculate average of numeric values".to_string(),
        }
    }
}

struct MaxReducer;

impl ReducerFunction for MaxReducer {
    fn execute(&self, items: &[IterationItem]) -> ReducerResult {
        items
            .iter()
            .filter_map(|item| match &item.value.value {
                serde_json::Value::Number(n) => n.as_f64(),
                _ => None,
            })
            .max_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal))
            .map(|v| v.to_string())
            .unwrap_or_default()
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "max".to_string(),
            function_type: FunctionType::Reducer,
            description: "Find maximum numeric value".to_string(),
        }
    }
}

struct MinReducer;

impl ReducerFunction for MinReducer {
    fn execute(&self, items: &[IterationItem]) -> ReducerResult {
        items
            .iter()
            .filter_map(|item| match &item.value.value {
                serde_json::Value::Number(n) => n.as_f64(),
                _ => None,
            })
            .min_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal))
            .map(|v| v.to_string())
            .unwrap_or_default()
    }

    fn metadata(&self) -> FunctionMetadata {
        FunctionMetadata {
            name: "min".to_string(),
            function_type: FunctionType::Reducer,
            description: "Find minimum numeric value".to_string(),
        }
    }
}

// ============================================================================
// Helper Functions
// ============================================================================

fn extract_text_value(field_value: &FieldValue) -> String {
    match &field_value.value {
        serde_json::Value::String(s) => s.clone(),
        serde_json::Value::Number(n) => n.to_string(),
        serde_json::Value::Bool(b) => b.to_string(),
        serde_json::Value::Object(map) => map
            .get("value")
            .map(|v| match v {
                serde_json::Value::String(s) => s.to_string(),
                serde_json::Value::Number(n) => n.to_string(),
                serde_json::Value::Bool(b) => b.to_string(),
                _ => String::new(),
            })
            .unwrap_or_default(),
        serde_json::Value::Array(arr) => arr
            .first()
            .and_then(|v| v.get("value"))
            .map(|v| match v {
                serde_json::Value::String(s) => s.to_string(),
                serde_json::Value::Number(n) => n.to_string(),
                serde_json::Value::Bool(b) => b.to_string(),
                _ => String::new(),
            })
            .unwrap_or_default(),
        serde_json::Value::Null => String::new(),
    }
}

fn split_words(text: &str) -> Vec<String> {
    text.split_whitespace().map(|s| s.to_string()).collect()
}

/// Public helper to split words - used by engine
pub fn split_text_into_words(text: &str) -> Vec<String> {
    split_words(text)
}

/// Public helper to extract text - used by engine
pub fn extract_field_text(field_value: &FieldValue) -> String {
    extract_text_value(field_value)
}

fn sorted_items(items: &[IterationItem]) -> Vec<&IterationItem> {
    let mut sorted: Vec<&IterationItem> = items.iter().collect();
    sorted.sort_by(|a, b| {
        let a_key = (
            a.key.hash.as_deref().unwrap_or(""),
            a.key.range.as_deref().unwrap_or(""),
        );
        let b_key = (
            b.key.hash.as_deref().unwrap_or(""),
            b.key.range.as_deref().unwrap_or(""),
        );
        a_key.cmp(&b_key)
    });
    sorted
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::schema::types::key_value::KeyValue;

    #[test]
    fn test_average_reducer() {
        let reg = registry();
        let reducer = reg
            .get_reducer("average")
            .expect("average reducer should exist");

        // Test normal average
        let items = vec![
            create_test_number_item(10.0),
            create_test_number_item(20.0),
            create_test_number_item(30.0),
        ];
        let result = reducer.execute(&items);
        assert_eq!(result, "20");

        // Test with decimal
        let items_decimal = vec![create_test_number_item(10.5), create_test_number_item(20.5)];
        let result_decimal = reducer.execute(&items_decimal);
        assert_eq!(result_decimal, "15.5");

        // Test empty
        let empty_items: Vec<IterationItem> = vec![];
        let result_empty = reducer.execute(&empty_items);
        assert_eq!(result_empty, "0");
    }

    fn create_test_number_item(num: f64) -> IterationItem {
        IterationItem {
            key: KeyValue::new(Some("test".to_string()), None),
            value: FieldValue {
                value: serde_json::Value::Number(serde_json::Number::from_f64(num).unwrap()),
                atom_uuid: "test-uuid".to_string(),
                source_file_name: None,
            },
            is_text_token: false,
        }
    }

    fn create_test_item(text: &str) -> IterationItem {
        IterationItem {
            key: KeyValue::new(Some("test".to_string()), None),
            value: FieldValue {
                value: serde_json::Value::String(text.to_string()),
                atom_uuid: "test-uuid".to_string(),
                source_file_name: None,
            },
            is_text_token: false,
        }
    }

    #[test]
    fn test_registry_initialization() {
        let reg = registry();

        // Check iterator functions
        assert!(reg.is_iterator("split_by_word"));
        assert!(reg.is_iterator("split_array"));

        // Check reducer functions
        assert!(reg.is_reducer("first"));
        assert!(reg.is_reducer("last"));
        assert!(reg.is_reducer("count"));
        assert!(reg.is_reducer("join"));
        assert!(reg.is_reducer("sum"));
        assert!(reg.is_reducer("max"));
        assert!(reg.is_reducer("min"));

        // Check unregistered
        assert!(!reg.is_registered("unknown_function"));
    }

    #[test]
    fn test_function_type_detection() {
        let reg = registry();

        assert_eq!(
            reg.get_function_type("split_by_word"),
            Some(FunctionType::Iterator)
        );
        assert_eq!(reg.get_function_type("first"), Some(FunctionType::Reducer));
        assert_eq!(reg.get_function_type("unknown"), None);
    }

    #[test]
    fn test_count_reducer() {
        let reg = registry();
        let reducer = reg
            .get_reducer("count")
            .expect("count reducer should exist");

        let items = vec![
            create_test_item("one"),
            create_test_item("two"),
            create_test_item("three"),
        ];

        let result = reducer.execute(&items);
        assert_eq!(result, "3");
    }

    #[test]
    fn test_join_reducer() {
        let reg = registry();
        let reducer = reg.get_reducer("join").expect("join reducer should exist");

        let items = vec![create_test_item("hello"), create_test_item("world")];

        let result = reducer.execute(&items);
        assert_eq!(result, "hello, world");
    }

    #[test]
    fn test_sum_reducer() {
        let reg = registry();
        let reducer = reg.get_reducer("sum").expect("sum reducer should exist");

        let items = vec![
            IterationItem {
                key: KeyValue::new(Some("test".to_string()), None),
                value: FieldValue {
                    value: serde_json::Value::Number(serde_json::Number::from(10)),
                    atom_uuid: "test-uuid".to_string(),
                    source_file_name: None,
                },
                is_text_token: false,
            },
            IterationItem {
                key: KeyValue::new(Some("test".to_string()), None),
                value: FieldValue {
                    value: serde_json::Value::Number(serde_json::Number::from(20)),
                    atom_uuid: "test-uuid".to_string(),
                    source_file_name: None,
                },
                is_text_token: false,
            },
        ];

        let result = reducer.execute(&items);
        assert_eq!(result, "30");
    }

    #[test]
    fn test_split_by_word_execution() {
        let reg = registry();
        let func = reg
            .get_iterator("split_by_word")
            .expect("split_by_word should exist");

        let item = create_test_item("hello world test");
        let result = func.execute(&item);

        match result {
            IteratorExecutionResult::TextTokens(tokens) => {
                assert_eq!(tokens, vec!["hello", "world", "test"]);
            }
            _ => panic!("Expected TextTokens result"),
        }

        let meta = func.metadata();
        assert_eq!(meta.name, "split_by_word");
        assert_eq!(meta.function_type, FunctionType::Iterator);
    }
}