liquid-cache 0.1.12

10x lower latency for cloud-native DataFusion
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
#[cfg(test)]
mod random_tests {
    use std::sync::Arc;

    use crate::cache::CacheExpression;
    use crate::cache::TestSqueezeIo;
    use crate::liquid_array::raw::FsstArray;
    use crate::liquid_array::{LiquidArray, LiquidByteArray, LiquidByteViewArray};
    use arrow::array::{
        Array, AsArray, BinaryViewArray, BooleanArray, DictionaryArray, StringArray,
        StringViewArray,
    };
    use arrow::buffer::BooleanBuffer;
    use arrow_schema::DataType;
    use rand::SeedableRng;
    use rand::prelude::*;

    fn make_impls_from_strings(input: &StringArray) -> Vec<(&'static str, Arc<dyn LiquidArray>)> {
        let ba = {
            let compressor = LiquidByteArray::train_compressor(input.iter());
            Arc::new(LiquidByteArray::from_string_array(input, compressor)) as Arc<dyn LiquidArray>
        };
        let bv = {
            let compressor = LiquidByteViewArray::<FsstArray>::train_compressor(input.iter());
            Arc::new(LiquidByteViewArray::<FsstArray>::from_string_array(
                input, compressor,
            )) as Arc<dyn LiquidArray>
        };
        vec![("byte_array", ba), ("byte_view", bv)]
    }

    // ---------- Randomized input generators (deterministic via seeds) ----------
    fn gen_random_string(rng: &mut StdRng, max_len: usize) -> String {
        const EXTRA: &[char] = &[
            '\0', '\n', '\t', 'é', 'ß', '', '', '', '🙂', '🚀', '🌍',
        ];
        let len = rng.random_range(0..=max_len);
        let mut out = String::new();
        for _ in 0..len {
            let pick_extra = rng.random_bool(0.2);
            let ch = if pick_extra {
                *EXTRA.choose(rng).unwrap()
            } else {
                // Printable ASCII range
                (rng.random_range(0x20u8..=0x7Eu8)) as char
            };
            out.push(ch);
        }
        out
    }

    fn gen_vec_opt_string(
        rng: &mut StdRng,
        max_items: usize,
        max_len: usize,
    ) -> Vec<Option<String>> {
        let n = rng.random_range(0..=max_items);
        (0..n)
            .map(|_| {
                if rng.random_bool(0.2) {
                    None
                } else {
                    Some(gen_random_string(rng, max_len))
                }
            })
            .collect()
    }

    fn gen_vec_opt_bytes(
        rng: &mut StdRng,
        max_items: usize,
        max_len: usize,
    ) -> Vec<Option<Vec<u8>>> {
        let n = rng.random_range(0..=max_items);
        (0..n)
            .map(|_| {
                if rng.random_bool(0.2) {
                    None
                } else {
                    let m = rng.random_range(0..=max_len);
                    let mut v = vec![0u8; m];
                    rng.fill_bytes(&mut v);
                    Some(v)
                }
            })
            .collect()
    }

    #[test]
    fn randomized_utf8_roundtrip_byte_and_view() {
        for seed in 0..50u64 {
            let mut rng = StdRng::seed_from_u64(0xC0FFEE + seed);
            let vals = gen_vec_opt_string(&mut rng, 64, 64);
            let input = StringArray::from(vals);
            for (_name, la) in make_impls_from_strings(&input) {
                assert_eq!(la.to_arrow_array().as_string::<i32>(), &input);
            }
        }
    }

    #[test]
    fn randomized_binaryview_roundtrip_byte_and_view() {
        for seed in 0..50u64 {
            let mut rng = StdRng::seed_from_u64(0xB1A5E + seed);
            let vals = gen_vec_opt_bytes(&mut rng, 64, 64);
            let opt_slices: Vec<Option<&[u8]>> = vals.iter().map(|o| o.as_deref()).collect();
            let input = BinaryViewArray::from(opt_slices);

            let (_compressor_ba, original_ba) = LiquidByteArray::train_from_binary_view(&input);
            assert_eq!(original_ba.to_arrow_array().as_binary_view(), &input);

            let (_compressor_bv, original_bv) =
                LiquidByteViewArray::<FsstArray>::train_from_binary_view(&input);
            let output_bv = original_bv.to_arrow_array();
            assert_eq!(output_bv.as_binary_view(), &input);
        }
    }

    #[test]
    fn randomized_stringview_roundtrip_byte_and_view() {
        for seed in 0..50u64 {
            let mut rng = StdRng::seed_from_u64(0x53_54_52_49 + seed);
            let vals = gen_vec_opt_string(&mut rng, 64, 64);
            let opt_slices: Vec<Option<&str>> = vals.iter().map(|o| o.as_deref()).collect();
            let input = StringViewArray::from(opt_slices);

            let (_compressor_ba, original_ba) = LiquidByteArray::train_from_string_view(&input);
            assert_eq!(original_ba.to_arrow_array().as_string_view(), &input);

            let (_compressor_bv, original_bv) =
                LiquidByteViewArray::<FsstArray>::train_from_string_view(&input);
            let output_bv = original_bv.to_arrow_array();
            assert_eq!(output_bv.as_string_view(), &input);
        }
    }

    #[test]
    fn randomized_to_bytes_and_from_bytes_roundtrip() {
        for seed in 0..50u64 {
            let mut rng = StdRng::seed_from_u64(0xB17E5 + seed);
            let vals = gen_vec_opt_string(&mut rng, 64, 64);
            let input = StringArray::from(vals);

            // ByteArray
            {
                let compressor = LiquidByteArray::train_compressor(input.iter());
                let original = LiquidByteArray::from_string_array(&input, compressor.clone());
                let bytes = original.to_bytes();
                let decoded = LiquidByteArray::from_bytes(bytes.into(), compressor);
                assert_eq!(decoded.to_arrow_array().as_string::<i32>(), &input);
            }

            // ByteViewArray
            {
                let compressor = LiquidByteViewArray::<FsstArray>::train_compressor(input.iter());
                let original =
                    LiquidByteViewArray::<FsstArray>::from_string_array(&input, compressor.clone());
                let bytes = original.to_bytes();
                let decoded =
                    LiquidByteViewArray::<FsstArray>::from_bytes(bytes.into(), compressor);
                let dec = decoded.to_arrow_array();
                assert_eq!(dec.as_string::<i32>(), &input);
            }
        }
    }

    #[test]
    fn randomized_filter_shared() {
        for seed in 0..50u64 {
            let mut rng = StdRng::seed_from_u64(0xF1_7E_E0 + seed);
            let vals = gen_vec_opt_string(&mut rng, 64, 64);
            let input = StringArray::from(vals);
            let mask_bits: Vec<bool> = (0..input.len()).map(|_| rng.random()).collect();
            let mask = BooleanBuffer::from_iter(mask_bits.iter().copied());

            for (_name, la) in make_impls_from_strings(&input) {
                let arr = la.filter(&mask).as_string::<i32>().clone();

                let expected_vals: Vec<Option<&str>> = (0..input.len())
                    .zip(mask_bits.iter())
                    .filter_map(|(i, &keep)| if keep { Some(i) } else { None })
                    .map(|i| {
                        if input.is_null(i) {
                            None
                        } else {
                            Some(input.value(i))
                        }
                    })
                    .collect();
                assert_eq!(arr, StringArray::from(expected_vals));
            }
        }
    }

    #[test]
    fn randomized_predicate_eq_shared() {
        use datafusion::logical_expr::Operator;
        use datafusion::physical_plan::expressions::{BinaryExpr, Column, Literal};
        use datafusion::scalar::ScalarValue;

        for seed in 0..50u64 {
            let mut rng = StdRng::seed_from_u64(0xE0 + seed);
            let vals = gen_vec_opt_string(&mut rng, 64, 64);
            let needle = gen_random_string(&mut rng, 32);
            let input = StringArray::from(vals);
            let mask = BooleanBuffer::new_set(input.len());
            let lit: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
                Arc::new(Literal::new(ScalarValue::Utf8(Some(needle.clone()))));
            let col: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
                Arc::new(Column::new("test_col", 0));
            let expr: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
                Arc::new(BinaryExpr::new(col, Operator::Eq, lit));

            for (_name, la) in make_impls_from_strings(&input) {
                if let Some(result) = la.try_eval_predicate(&expr, &mask) {
                    let expected: Vec<Option<bool>> =
                        input.iter().map(|o| o.map(|s| s == needle)).collect();
                    assert_eq!(result, BooleanArray::from(expected));
                }
            }
        }
    }

    #[test]
    fn randomized_byte_view_squeeze_full_read_roundtrip() {
        for seed in 0..25u64 {
            // slightly fewer to keep runtime reasonable
            let mut rng = StdRng::seed_from_u64(0x50_55_45_33 + seed);
            let vals = gen_vec_opt_string(&mut rng, 32, 64);
            let input = StringArray::from(vals);
            let compressor = LiquidByteViewArray::<FsstArray>::train_compressor(input.iter());
            let decode_compressor = compressor.clone();
            let liquid = LiquidByteViewArray::<FsstArray>::from_string_array(&input, compressor);

            if let Some((_hybrid, bytes)) = liquid.squeeze(Arc::new(TestSqueezeIo::default()), None)
            {
                let restored = crate::liquid_array::ipc::read_from_bytes(
                    bytes.clone(),
                    &crate::liquid_array::ipc::LiquidIPCContext::new(Some(decode_compressor)),
                );

                let a1 = LiquidArray::to_arrow_array(&liquid);
                let a2 = restored.to_arrow_array();
                assert_eq!(a1.as_ref(), a2.as_ref());
            }
        }
    }

    #[test]
    fn utf8_roundtrip_byte_and_view() {
        let cases: Vec<Vec<Option<&str>>> = vec![
            vec![
                Some("hello"),
                Some("world"),
                None,
                Some("liquid"),
                Some("byte"),
                Some("array"),
                Some("hello"),
                Some(""),
            ],
            vec![
                Some("This is a very long string that should be compressed well"),
                Some("Another long string with some common patterns"),
                Some("This is a very long string that should be compressed well"),
                Some("Some unique text here to mix things up"),
                Some("Another long string with some common patterns"),
            ],
            vec![
                Some("こんにちは"),
                Some("世界"),
                None,
                Some("rust"),
                Some(""),
                Some("🌍"),
            ],
        ];

        for vals in cases {
            let input = StringArray::from(vals);
            for (_name, la) in make_impls_from_strings(&input) {
                assert_eq!(la.to_arrow_array().as_string::<i32>(), &input);
            }
        }
    }

    #[test]
    fn binaryview_roundtrip_byte_and_view() {
        let input = BinaryViewArray::from(vec![
            Some(b"hello".as_slice()),
            Some(b"world".as_slice()),
            Some(b"hello".as_slice()),
            Some(b"rust\x00".as_slice()),
            None,
            Some(b"This is a very long string that should be compressed well"),
            Some(b""),
            Some(b"This is a very long string that should be compressed well"),
        ]);

        // LiquidByteArray via BinaryView
        let (_compressor_ba, original_ba) = LiquidByteArray::train_from_binary_view(&input);
        let output_ba = original_ba.to_arrow_array();
        assert_eq!(output_ba.as_binary_view(), &input);

        // LiquidByteViewArray via BinaryView
        let (_compressor_bv, original_bv) =
            LiquidByteViewArray::<FsstArray>::train_from_binary_view(&input);
        let output_bv = original_bv.to_arrow_array();
        assert_eq!(output_bv.as_binary_view(), &input);
    }

    #[test]
    fn stringview_roundtrip_byte_and_view() {
        let input = StringViewArray::from(vec![
            Some("hello"),
            Some("world"),
            Some("hello"),
            Some("rust"),
            None,
            Some("long text"),
            Some(""),
        ]);

        // ByteArray via StringView
        let (_compressor_ba, original_ba) = LiquidByteArray::train_from_string_view(&input);
        let output_ba = original_ba.to_arrow_array();
        assert_eq!(output_ba.as_string_view(), &input);

        // ByteViewArray via StringView
        let (_compressor_bv, original_bv) =
            LiquidByteViewArray::<FsstArray>::train_from_string_view(&input);
        let output_bv = original_bv.to_arrow_array();
        assert_eq!(output_bv.as_string_view(), &input);
    }

    #[test]
    fn to_dict_arrow_preserves_value_type_shared() {
        // String values
        let input_str = StringArray::from(vec!["hello", "world", "test"]);
        {
            let (_c, ba) = LiquidByteArray::train_from_arrow(&input_str);
            let dict = ba.to_dict_arrow();
            assert_eq!(dict.values().data_type(), &DataType::Utf8);
        }
        {
            let (_c, bv) = LiquidByteViewArray::<FsstArray>::train_from_arrow(&input_str);
            let dict = bv.to_dict_arrow();
            assert_eq!(dict.values().data_type(), &DataType::Utf8);
        }

        // Binary values
        let input_bin = arrow::compute::cast(&input_str, &DataType::Binary)
            .unwrap()
            .as_binary::<i32>()
            .clone();
        {
            let (_c, ba) = LiquidByteArray::train_from_arrow(&input_bin);
            let dict = ba.to_dict_arrow();
            assert_eq!(dict.values().data_type(), &DataType::Binary);
        }
        {
            let (_c, bv) = LiquidByteViewArray::<FsstArray>::train_from_arrow(&input_bin);
            let dict = bv.to_dict_arrow();
            assert_eq!(dict.values().data_type(), &DataType::Binary);
        }

        // Dictionary<String> values
        let dict_array: DictionaryArray<arrow::datatypes::UInt16Type> =
            DictionaryArray::from_iter(input_str.iter());
        {
            let (_c, ba) = LiquidByteArray::train_from_arrow_dict(&dict_array);
            let dict = ba.to_dict_arrow();
            assert_eq!(dict.values().data_type(), &DataType::Utf8);
        }
        {
            let (_c, bv) = LiquidByteViewArray::<FsstArray>::train_from_arrow_dict(&dict_array);
            let dict = bv.to_dict_arrow();
            assert_eq!(dict.values().data_type(), &DataType::Utf8);
        }
    }

    #[test]
    fn compare_equals_shared() {
        let cases = vec![
            (
                vec![Some("hello"), Some("world"), Some("hello"), Some("rust")],
                "hello",
                vec![Some(true), Some(false), Some(true), Some(false)],
            ),
            (
                vec![Some("hello"), Some("world"), Some("hello"), Some("rust")],
                "nonexistent",
                vec![Some(false), Some(false), Some(false), Some(false)],
            ),
            (
                vec![Some("hello"), None, Some("hello"), None, Some("world")],
                "hello",
                vec![Some(true), None, Some(true), None, Some(false)],
            ),
            (
                vec![Some(""), Some("hello"), Some(""), Some("world")],
                "",
                vec![Some(true), Some(false), Some(true), Some(false)],
            ),
        ];

        for (vals, needle, expected) in cases {
            let input = StringArray::from(vals);
            // Build a predicate: array == literal(needle)
            use datafusion::logical_expr::Operator;
            use datafusion::physical_plan::expressions::{BinaryExpr, Column, Literal};
            use datafusion::scalar::ScalarValue;
            let mask = BooleanBuffer::new_set(input.len());
            let lit: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
                Arc::new(Literal::new(ScalarValue::Utf8(Some(needle.to_string()))));
            let col: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
                Arc::new(Column::new("test_col", 0));
            let expr: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
                Arc::new(BinaryExpr::new(col, Operator::Eq, lit));

            for (_name, la) in make_impls_from_strings(&input) {
                if let Some(result) = la.try_eval_predicate(&expr, &mask) {
                    assert_eq!(result, BooleanArray::from(expected.clone()));
                }
            }
        }
    }

    #[test]
    fn to_bytes_and_from_bytes_roundtrip_shared() {
        let input = StringArray::from(vec![
            Some("a"),
            None,
            Some("b"),
            Some("a"),
            Some("longer text"),
            Some(""),
        ]);

        // ByteArray
        {
            let compressor = LiquidByteArray::train_compressor(input.iter());
            let original = LiquidByteArray::from_string_array(&input, compressor.clone());
            let bytes = original.to_bytes();
            let decoded = LiquidByteArray::from_bytes(bytes.into(), compressor);
            assert_eq!(decoded.to_arrow_array().as_string::<i32>(), &input);
        }

        // ByteViewArray
        {
            let compressor = LiquidByteViewArray::<FsstArray>::train_compressor(input.iter());
            let original =
                LiquidByteViewArray::<FsstArray>::from_string_array(&input, compressor.clone());
            let bytes = original.to_bytes();
            let decoded = LiquidByteViewArray::<FsstArray>::from_bytes(bytes.into(), compressor);
            let dec = decoded.to_arrow_array();
            let ori = original.to_arrow_array();
            assert_eq!(dec.as_ref(), ori.as_ref());
        }
    }

    #[test]
    fn filter_shared_even_indices() {
        let input = StringArray::from(vec![
            Some("x"),
            Some("y"),
            None,
            Some("z"),
            Some("x"),
            Some("y"),
            Some("z"),
        ]);
        let mask = BooleanBuffer::from_iter((0..input.len()).map(|i| i.is_multiple_of(2)));

        for (_name, la) in make_impls_from_strings(&input) {
            let arr = la.filter(&mask).as_string::<i32>().clone();
            // Build expected via filtering input directly
            let expected_vals: Vec<Option<&str>> = (0..input.len())
                .filter(|i| i.is_multiple_of(2))
                .map(|i| {
                    if input.is_null(i) {
                        None
                    } else {
                        Some(input.value(i))
                    }
                })
                .collect();
            assert_eq!(arr, StringArray::from(expected_vals));
        }
    }

    #[test]
    fn predicate_eq_shared() {
        use datafusion::logical_expr::Operator;
        use datafusion::physical_plan::expressions::{BinaryExpr, Column, Literal};
        use datafusion::scalar::ScalarValue;
        let input = StringArray::from(vec![
            Some("hello"),
            None,
            Some("world"),
            Some("hello"),
            Some(""),
            Some("rust"),
        ]);
        let mask = BooleanBuffer::new_set(input.len());
        let lit: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
            Arc::new(Literal::new(ScalarValue::Utf8(Some("hello".to_string()))));
        let col: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
            Arc::new(Column::new("test_col", 0));
        let expr: Arc<dyn datafusion::physical_plan::PhysicalExpr> =
            Arc::new(BinaryExpr::new(col, Operator::Eq, lit));

        for (_name, la) in make_impls_from_strings(&input) {
            if let Some(result) = la.try_eval_predicate(&expr, &mask) {
                // Build expected
                let expected = BooleanArray::from(vec![
                    Some(true),
                    None,
                    Some(false),
                    Some(true),
                    Some(false),
                    Some(false),
                ]);
                assert_eq!(result, expected);
            }
        }
    }

    #[test]
    fn byte_view_squeeze_and_full_read_roundtrip() {
        // Build a small array
        let input = StringArray::from(vec![
            Some("hello"),
            Some("world"),
            Some("hello"),
            None,
            Some("byteview"),
        ]);
        let compressor = LiquidByteViewArray::<FsstArray>::train_compressor(input.iter());
        let decode_compressor = compressor.clone();
        let liquid = LiquidByteViewArray::<FsstArray>::from_string_array(&input, compressor);

        // Full IPC bytes as baseline
        let baseline = liquid.to_bytes();

        // Squeeze
        let Some((_hybrid, bytes)) = liquid.squeeze(
            Arc::new(TestSqueezeIo::default()),
            Some(&CacheExpression::PredicateColumn),
        ) else {
            panic!("squeeze should succeed");
        };

        // Hydrate from full IPC bytes
        let restored = crate::liquid_array::ipc::read_from_bytes(
            bytes.clone(),
            &crate::liquid_array::ipc::LiquidIPCContext::new(Some(decode_compressor)),
        );

        // Arrow equality check
        let a1 = LiquidArray::to_arrow_array(&liquid);
        let a2 = restored.to_arrow_array();
        assert_eq!(a1.as_ref(), a2.as_ref());

        // IPC bytes should match as well
        assert_eq!(baseline, restored.to_bytes());
    }
}