aisle 0.2.0

Metadata-driven Parquet pruning for Rust: Skip irrelevant data before reading
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
//! Null count edge case tests for row-group and page-level pruning.
//!
//! Tests coverage:
//! - null_count = 0 (no nulls)
//! - null_count = row_count (all nulls)
//! - partial null_count (some nulls)
//! - null_count = None (missing stats)
//!
//! Predicates tested:
//! - IS NULL / IS NOT NULL
//! - Comparison operators with nulls (=, !=, <, >, <=, >=)
//! - IN list with nulls
//! - BETWEEN with nulls

use std::sync::Arc;

use aisle::PruneRequest;
use arrow_array::{Int32Array, RecordBatch};
use arrow_schema::{DataType, Field, Schema};
use bytes::Bytes;
use datafusion_expr::{col, lit};
use parquet::{
    arrow::ArrowWriter,
    file::{
        metadata::{PageIndexPolicy, ParquetMetaData, ParquetMetaDataReader},
        properties::{EnabledStatistics, WriterProperties},
    },
};

fn make_batch_nullable(schema: &Schema, values: Vec<Option<i32>>) -> RecordBatch {
    let array = Int32Array::from(values);
    RecordBatch::try_new(Arc::new(schema.clone()), vec![Arc::new(array)]).unwrap()
}

fn write_parquet(batches: &[RecordBatch], props: WriterProperties) -> Vec<u8> {
    let mut buffer: Vec<u8> = Vec::new();
    let schema = batches[0].schema();
    let mut writer = ArrowWriter::try_new(&mut buffer, schema, Some(props)).unwrap();
    for batch in batches {
        writer.write(batch).unwrap();
    }
    writer.close().unwrap();
    buffer
}

fn load_metadata(bytes: &[u8]) -> ParquetMetaData {
    let bytes = Bytes::copy_from_slice(bytes);
    ParquetMetaDataReader::new()
        .with_page_index_policy(PageIndexPolicy::Required)
        .parse_and_finish(&bytes)
        .unwrap()
}

fn load_metadata_without_page_index(bytes: &[u8]) -> ParquetMetaData {
    let bytes = Bytes::copy_from_slice(bytes);
    ParquetMetaDataReader::new()
        .with_page_index_policy(PageIndexPolicy::Skip)
        .parse_and_finish(&bytes)
        .unwrap()
}

// ============================================================================
// Row-group level: IS NULL / IS NOT NULL
// ============================================================================

#[test]
fn is_null_with_zero_nulls() {
    // null_count = 0 => IS NULL should prune (return False)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), Some(2), Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").is_null();
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should prune: no nulls present
    assert_eq!(result.row_groups(), &[] as &[usize]);
}

#[test]
fn is_null_with_all_nulls() {
    // null_count = row_count => IS NULL should keep (return True)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![None, None, None]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").is_null();
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: all nulls
    assert_eq!(result.row_groups(), &[0]);
}

#[test]
fn is_null_with_partial_nulls() {
    // partial null_count => IS NULL should keep (return Unknown)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), None, Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").is_null();
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: might have nulls
    assert_eq!(result.row_groups(), &[0]);
}

#[test]
fn is_not_null_with_zero_nulls() {
    // null_count = 0 => IS NOT NULL should keep (return True)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), Some(2), Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").is_not_null();
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: all non-null
    assert_eq!(result.row_groups(), &[0]);
}

#[test]
fn is_not_null_with_all_nulls() {
    // null_count = row_count => IS NOT NULL should prune (return False)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![None, None, None]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").is_not_null();
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should prune: all nulls
    assert_eq!(result.row_groups(), &[] as &[usize]);
}

#[test]
fn is_not_null_with_partial_nulls() {
    // partial null_count => IS NOT NULL should keep (return Unknown)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), None, Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").is_not_null();
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: might have non-nulls
    assert_eq!(result.row_groups(), &[0]);
}

// ============================================================================
// Row-group level: Comparison operators with nulls
// ============================================================================

#[test]
fn eq_with_zero_nulls_matching() {
    // null_count = 0, value in range => should keep
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), Some(2), Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").eq(lit(2));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    assert_eq!(result.row_groups(), &[0]);
}

#[test]
fn eq_with_all_nulls() {
    // null_count = row_count => should ideally prune, but current behavior
    // is conservative (keeps) because min/max stats are None
    // SQL semantics: NULL = value evaluates to NULL (falsy), so no rows match
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![None, None, None]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").eq(lit(2));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Current behavior: keeps (conservative, because min/max are None)
    // Ideal behavior: prune (because NULL = x is always falsy)
    assert_eq!(result.row_groups(), &[0]); // Conservative keep
}

#[test]
fn eq_with_partial_nulls_in_range() {
    // partial nulls, value in range => keep (might have matching rows)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), None, Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").eq(lit(2));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: value 2 is in range [1, 3]
    assert_eq!(result.row_groups(), &[0]);
}

#[test]
fn not_eq_with_zero_nulls() {
    // null_count = 0, min == max == value => should prune
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(2), Some(2), Some(2)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").not_eq(lit(2));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should prune: all values are 2
    assert_eq!(result.row_groups(), &[] as &[usize]);
}

#[test]
fn not_eq_with_nulls() {
    // min == max == value with nulls > 0
    // All non-null values are 2, so they don't match `!= 2`
    // Null values: NULL != 2 evaluates to NULL (falsy)
    // Therefore NO rows match the predicate
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(2), None, Some(2)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").not_eq(lit(2));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should prune: min==max==value means all non-nulls are 2,
    // and NULL != 2 is falsy, so no rows match
    assert_eq!(result.row_groups(), &[] as &[usize]);
}

#[test]
fn lt_with_zero_nulls_can_prune() {
    // null_count = 0, min >= value => should prune
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(5), Some(6), Some(7)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").lt(lit(5));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should prune: all values >= 5
    assert_eq!(result.row_groups(), &[] as &[usize]);
}

#[test]
fn lt_with_zero_nulls_keeps_all() {
    // null_count = 0, max < value => should keep all (True)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), Some(2), Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").lt(lit(5));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: all values < 5
    assert_eq!(result.row_groups(), &[0]);
}

#[test]
fn lt_with_nulls() {
    // Has nulls => max < value would still only return True if null_count = 0
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), None, Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").lt(lit(5));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: Unknown (has nulls)
    assert_eq!(result.row_groups(), &[0]);
}

// ============================================================================
// Row-group level: IN list with nulls
// ============================================================================

#[test]
fn in_list_with_zero_nulls() {
    // null_count = 0, value in range => keep
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), Some(2), Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").in_list(vec![lit(2), lit(5)], false);
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: 2 is in range
    assert_eq!(result.row_groups(), &[0]);
}

#[test]
fn in_list_with_all_nulls() {
    // null_count = row_count => should ideally prune, but current behavior
    // is conservative (keeps) because min/max stats are None
    // SQL semantics: NULL IN (values) evaluates to NULL (falsy), so no rows match
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![None, None, None]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Chunk)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").in_list(vec![lit(1), lit(2)], false);
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Current behavior: keeps (conservative, because min/max are None)
    // Ideal behavior: prune (because NULL IN (...) is always falsy)
    assert_eq!(result.row_groups(), &[0]); // Conservative keep
}

// ============================================================================
// Page-level: null count edge cases
// ============================================================================

#[test]
fn page_level_is_null_with_mixed_pages() {
    // Pages with varying null counts
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);

    // Create batches: first has nulls, second doesn't
    let batch1 = make_batch_nullable(&schema, vec![None, None]);
    let batch2 = make_batch_nullable(&schema, vec![Some(1), Some(2)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Page)
        .set_data_page_row_count_limit(2)
        .set_max_row_group_size(100)
        .build();

    let bytes = write_parquet(&[batch1, batch2], props);
    let metadata = load_metadata(&bytes);

    let expr = col("a").is_null();
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(true)
        .prune();

    assert_eq!(result.row_groups(), &[0]);

    // Should have page-level selection
    if result.row_selection().is_some() {
        let selection = result.row_selection().unwrap();
        // At least some rows should be selected (the null page)
        assert!(selection.selects_any());
    }
}

#[test]
fn page_level_comparison_with_zero_null_count() {
    // Page with null_count = 0 should allow aggressive pruning
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), Some(2), Some(10), Some(11)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::Page)
        .set_data_page_row_count_limit(2)
        .set_max_row_group_size(100)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata(&bytes);

    let expr = col("a").gt(lit(5));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(true)
        .prune();

    assert_eq!(result.row_groups(), &[0]);

    if result.row_selection().is_some() {
        let selection = result.row_selection().unwrap();
        // Should prune first page (values 1, 2), keep second page (values 10, 11)
        assert!(selection.selects_any());
    }
}

#[test]
fn missing_stats_returns_unknown() {
    // When statistics are disabled, should be conservative (keep everything)
    let schema = Schema::new(vec![Field::new("a", DataType::Int32, true)]);
    let batch = make_batch_nullable(&schema, vec![Some(1), Some(2), Some(3)]);

    let props = WriterProperties::builder()
        .set_statistics_enabled(EnabledStatistics::None)
        .build();

    let bytes = write_parquet(&[batch], props);
    let metadata = load_metadata_without_page_index(&bytes);

    let expr = col("a").eq(lit(100));
    let result = PruneRequest::new(&metadata, &schema)
        .with_predicate(&expr)
        .enable_page_index(false)
        .prune();

    // Should keep: no stats available (conservative)
    assert_eq!(result.row_groups(), &[0]);
}