parquet 60.1.0

Apache Parquet implementation in Rust
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

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

//! Reader options for encoding statistics, size statistics, and page indexes.

use super::*;

#[test]
fn test_page_encoding_stats_mask() {
    let testdata = arrow::util::test_util::parquet_test_data();
    let path = format!("{testdata}/alltypes_tiny_pages.parquet");
    let file = File::open(path).unwrap();

    let arrow_options = ArrowReaderOptions::new().with_encoding_stats_as_mask(true);
    let builder =
        ParquetRecordBatchReaderBuilder::try_new_with_options(file, arrow_options).unwrap();

    let row_group_metadata = builder.metadata.row_group(0);

    // test page encoding stats
    let page_encoding_stats = row_group_metadata
        .column(0)
        .page_encoding_stats_mask()
        .unwrap();
    assert!(page_encoding_stats.is_only(Encoding::PLAIN));
    let page_encoding_stats = row_group_metadata
        .column(2)
        .page_encoding_stats_mask()
        .unwrap();
    assert!(page_encoding_stats.is_only(Encoding::PLAIN_DICTIONARY));
}

#[test]
fn test_stats_stats_skipped() {
    let testdata = arrow::util::test_util::parquet_test_data();
    let path = format!("{testdata}/alltypes_tiny_pages.parquet");
    let file = File::open(path).unwrap();

    // test skipping all
    let arrow_options = ArrowReaderOptions::new()
        .with_encoding_stats_policy(ParquetStatisticsPolicy::SkipAll)
        .with_column_stats_policy(ParquetStatisticsPolicy::SkipAll);
    let builder = ParquetRecordBatchReaderBuilder::try_new_with_options(
        file.try_clone().unwrap(),
        arrow_options,
    )
    .unwrap();

    let row_group_metadata = builder.metadata.row_group(0);
    for column in row_group_metadata.columns() {
        assert!(column.page_encoding_stats().is_none());
        assert!(column.page_encoding_stats_mask().is_none());
        assert!(column.statistics().is_none());
    }

    // test skipping all but one column and converting to mask
    let arrow_options = ArrowReaderOptions::new()
        .with_encoding_stats_as_mask(true)
        .with_encoding_stats_policy(ParquetStatisticsPolicy::skip_except(&[0]))
        .with_column_stats_policy(ParquetStatisticsPolicy::skip_except(&[0]));
    let builder = ParquetRecordBatchReaderBuilder::try_new_with_options(
        file.try_clone().unwrap(),
        arrow_options,
    )
    .unwrap();

    let row_group_metadata = builder.metadata.row_group(0);
    for (idx, column) in row_group_metadata.columns().iter().enumerate() {
        assert!(column.page_encoding_stats().is_none());
        assert_eq!(column.page_encoding_stats_mask().is_some(), idx == 0);
        assert_eq!(column.statistics().is_some(), idx == 0);
    }
}

#[test]
fn test_size_stats_stats_skipped() {
    let testdata = arrow::util::test_util::parquet_test_data();
    let path = format!("{testdata}/repeated_primitive_no_list.parquet");
    let file = File::open(path).unwrap();

    // test skipping all
    let arrow_options =
        ArrowReaderOptions::new().with_size_stats_policy(ParquetStatisticsPolicy::SkipAll);
    let builder = ParquetRecordBatchReaderBuilder::try_new_with_options(
        file.try_clone().unwrap(),
        arrow_options,
    )
    .unwrap();

    let row_group_metadata = builder.metadata.row_group(0);
    for column in row_group_metadata.columns() {
        assert!(column.repetition_level_histogram().is_none());
        assert!(column.definition_level_histogram().is_none());
        assert!(column.unencoded_byte_array_data_bytes().is_none());
    }

    // test skipping all but one column and converting to mask
    let arrow_options = ArrowReaderOptions::new()
        .with_encoding_stats_as_mask(true)
        .with_size_stats_policy(ParquetStatisticsPolicy::skip_except(&[1]));
    let builder = ParquetRecordBatchReaderBuilder::try_new_with_options(
        file.try_clone().unwrap(),
        arrow_options,
    )
    .unwrap();

    let row_group_metadata = builder.metadata.row_group(0);
    for (idx, column) in row_group_metadata.columns().iter().enumerate() {
        assert_eq!(column.repetition_level_histogram().is_some(), idx == 1);
        assert_eq!(column.definition_level_histogram().is_some(), idx == 1);
        assert_eq!(column.unencoded_byte_array_data_bytes().is_some(), idx == 1);
    }
}

#[test]
#[cfg_attr(miri, ignore)] // Takes too long
fn test_read_with_page_index_enabled() {
    let testdata = arrow::util::test_util::parquet_test_data();

    {
        // `alltypes_tiny_pages.parquet` has page index
        let path = format!("{testdata}/alltypes_tiny_pages.parquet");
        let test_file = File::open(path).unwrap();
        let builder = ParquetRecordBatchReaderBuilder::try_new_with_options(
            test_file,
            ArrowReaderOptions::new().with_page_index_policy(PageIndexPolicy::Required),
        )
        .unwrap();
        let row_group_page_index = builder.metadata().page_index_for_row_group(0);
        assert!(row_group_page_index.offset_index(0).is_some());
        assert!(row_group_page_index.column_index(0).is_some());
        assert!(row_group_page_index.page_locations(0).is_some());
        assert_eq!(row_group_page_index.num_data_pages(0), Some(325));
        let reader = builder.build().unwrap();
        let batches = reader.collect::<Result<Vec<_>, _>>().unwrap();
        assert_eq!(batches.len(), 8);
    }

    {
        // `alltypes_plain.parquet` doesn't have page index
        let path = format!("{testdata}/alltypes_plain.parquet");
        let test_file = File::open(path).unwrap();
        let builder = ParquetRecordBatchReaderBuilder::try_new_with_options(
            test_file,
            ArrowReaderOptions::new().with_page_index_policy(PageIndexPolicy::Required),
        )
        .unwrap();
        // Although `Vec<Vec<PageLocation>>` of each row group is empty,
        // we should read the file successfully.
        assert!(builder.metadata().page_index().is_none());
        let reader = builder.build().unwrap();
        let batches = reader.collect::<Result<Vec<_>, _>>().unwrap();
        assert_eq!(batches.len(), 1);
    }
}