Skip to main content

parquet/arrow/arrow_writer/
mod.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! Contains writer which writes arrow data into parquet data.
19
20use crate::column::chunker::ContentDefinedChunker;
21
22use bytes::Bytes;
23use std::io::Write;
24use std::slice::Iter;
25use std::sync::{Arc, Mutex};
26use std::vec::IntoIter;
27
28use arrow_array::cast::AsArray;
29use arrow_array::{ArrayRef, Int32Array, RecordBatch, RecordBatchWriter};
30use arrow_array::{PrimitiveArray, types::*};
31use arrow_schema::{
32    ArrowError, DataType as ArrowDataType, Field, IntervalUnit, SchemaRef, TimeUnit,
33};
34
35use super::schema::{add_encoded_arrow_schema_to_metadata, decimal_length_from_precision};
36
37use crate::arrow::ArrowSchemaConverter;
38use crate::arrow::arrow_writer::byte_array::ByteArrayEncoder;
39use crate::basic::PageType;
40use crate::column::page::{CompressedPage, PageWriteSpec, PageWriter};
41use crate::column::page_encryption::PageEncryptor;
42use crate::column::writer::encoder::ColumnValueEncoder;
43use crate::column::writer::{
44    ColumnCloseResult, ColumnWriter, GenericColumnWriter, get_column_writer,
45};
46use crate::data_type::{ByteArray, FixedLenByteArray};
47#[cfg(feature = "encryption")]
48use crate::encryption::encrypt::FileEncryptor;
49use crate::errors::{ParquetError, Result};
50use crate::file::metadata::{KeyValue, ParquetMetaData, RowGroupMetaData};
51use crate::file::properties::{WriterProperties, WriterPropertiesPtr};
52use crate::file::writer::{SerializedFileWriter, SerializedRowGroupWriter};
53use crate::parquet_thrift::{ThriftCompactOutputProtocol, WriteThrift};
54use crate::schema::types::{ColumnDescPtr, SchemaDescPtr, SchemaDescriptor};
55use levels::{ArrayLevels, calculate_array_levels};
56
57mod byte_array;
58mod levels;
59
60#[doc(inline)]
61pub use crate::column::page_store::{
62    InMemoryPageStore, InMemoryPageStoreFactory, PageKey, PageStore, PageStoreArgs,
63    PageStoreFactory,
64};
65
66/// Encodes [`RecordBatch`] to parquet
67///
68/// Writes Arrow `RecordBatch`es to a Parquet writer. Multiple [`RecordBatch`] will be encoded
69/// to the same row group, up to `max_row_group_size` rows. Any remaining rows will be
70/// flushed on close, leading the final row group in the output file to potentially
71/// contain fewer than `max_row_group_size` rows
72///
73/// # Example: Writing `RecordBatch`es
74/// ```
75/// # use std::sync::Arc;
76/// # use bytes::Bytes;
77/// # use arrow_array::{ArrayRef, Int64Array};
78/// # use arrow_array::RecordBatch;
79/// # use parquet::arrow::arrow_writer::ArrowWriter;
80/// # use parquet::arrow::arrow_reader::ParquetRecordBatchReader;
81/// let col = Arc::new(Int64Array::from_iter_values([1, 2, 3])) as ArrayRef;
82/// let to_write = RecordBatch::try_from_iter([("col", col)]).unwrap();
83///
84/// let mut buffer = Vec::new();
85/// let mut writer = ArrowWriter::try_new(&mut buffer, to_write.schema(), None).unwrap();
86/// writer.write(&to_write).unwrap();
87/// writer.close().unwrap();
88///
89/// let mut reader = ParquetRecordBatchReader::try_new(Bytes::from(buffer), 1024).unwrap();
90/// let read = reader.next().unwrap().unwrap();
91///
92/// assert_eq!(to_write, read);
93/// ```
94///
95/// # Memory Usage and Limiting
96///
97/// The nature of Parquet requires buffering of an entire row group before it can
98/// be flushed to the underlying writer. Data is mostly buffered in its encoded
99/// form, reducing memory usage. However, some data such as dictionary keys,
100/// large strings or very nested data may still result in non-trivial memory
101/// usage.
102///
103/// See Also:
104/// * [`ArrowWriter::memory_size`]: the current memory usage of the writer.
105/// * [`ArrowWriter::in_progress_size`]: Estimated size of the buffered row group,
106///
107/// Call [`Self::flush`] to trigger an early flush of a row group based on a
108/// memory threshold and/or global memory pressure. However,  smaller row groups
109/// result in higher metadata overheads, and thus may worsen compression ratios
110/// and query performance.
111///
112/// ```no_run
113/// # use std::io::Write;
114/// # use arrow_array::RecordBatch;
115/// # use parquet::arrow::ArrowWriter;
116/// # let mut writer: ArrowWriter<Vec<u8>> = todo!();
117/// # let batch: RecordBatch = todo!();
118/// writer.write(&batch).unwrap();
119/// // Trigger an early flush if anticipated size exceeds 1_000_000
120/// if writer.in_progress_size() > 1_000_000 {
121///     writer.flush().unwrap();
122/// }
123/// ```
124///
125/// ## Type Support
126///
127/// The writer supports writing all Arrow [`DataType`]s that have a direct mapping to
128/// Parquet types including  [`StructArray`] and [`ListArray`].
129///
130/// The following are not supported:
131///
132/// * [`IntervalMonthDayNanoArray`]: Parquet does not [support nanosecond intervals].
133///
134/// [`DataType`]: https://docs.rs/arrow/latest/arrow/datatypes/enum.DataType.html
135/// [`StructArray`]: https://docs.rs/arrow/latest/arrow/array/struct.StructArray.html
136/// [`ListArray`]: https://docs.rs/arrow/latest/arrow/array/type.ListArray.html
137/// [`IntervalMonthDayNanoArray`]: https://docs.rs/arrow/latest/arrow/array/type.IntervalMonthDayNanoArray.html
138/// [support nanosecond intervals]: https://github.com/apache/parquet-format/blob/master/LogicalTypes.md#interval
139///
140/// ## Type Compatibility
141/// The writer can write Arrow [`RecordBatch`]s that are logically equivalent. This means that for
142/// a  given column, the writer can accept multiple Arrow [`DataType`]s that contain the same
143/// value type.
144///
145/// For example, the following [`DataType`]s are all logically equivalent and can be written
146/// to the same column:
147/// * String, LargeString, StringView
148/// * Binary, LargeBinary, BinaryView
149///
150/// The writer can will also accept both native and dictionary encoded arrays if the dictionaries
151/// contain compatible values.
152/// ```
153/// # use std::sync::Arc;
154/// # use arrow_array::{DictionaryArray, LargeStringArray, RecordBatch, StringArray, UInt8Array};
155/// # use arrow_schema::{DataType, Field, Schema};
156/// # use parquet::arrow::arrow_writer::ArrowWriter;
157/// let record_batch1 = RecordBatch::try_new(
158///    Arc::new(Schema::new(vec![Field::new("col", DataType::LargeUtf8, false)])),
159///    vec![Arc::new(LargeStringArray::from_iter_values(vec!["a", "b"]))]
160///  )
161/// .unwrap();
162///
163/// let mut buffer = Vec::new();
164/// let mut writer = ArrowWriter::try_new(&mut buffer, record_batch1.schema(), None).unwrap();
165/// writer.write(&record_batch1).unwrap();
166///
167/// let record_batch2 = RecordBatch::try_new(
168///     Arc::new(Schema::new(vec![Field::new(
169///         "col",
170///         DataType::Dictionary(Box::new(DataType::UInt8), Box::new(DataType::Utf8)),
171///          false,
172///     )])),
173///     vec![Arc::new(DictionaryArray::new(
174///          UInt8Array::from_iter_values(vec![0, 1]),
175///          Arc::new(StringArray::from_iter_values(vec!["b", "c"])),
176///      ))],
177///  )
178///  .unwrap();
179///  writer.write(&record_batch2).unwrap();
180///  writer.close();
181/// ```
182pub struct ArrowWriter<W: Write> {
183    /// Underlying Parquet writer
184    writer: SerializedFileWriter<W>,
185
186    /// The in-progress row group if any
187    in_progress: Option<ArrowRowGroupWriter>,
188
189    /// A copy of the Arrow schema.
190    ///
191    /// The schema is used to verify that each record batch written has the correct schema
192    arrow_schema: SchemaRef,
193
194    /// Creates new [`ArrowRowGroupWriter`] instances as required
195    row_group_writer_factory: ArrowRowGroupWriterFactory,
196
197    /// The maximum number of rows to write to each row group, or None for unlimited
198    max_row_group_row_count: Option<usize>,
199
200    /// The maximum size in bytes for a row group, or None for unlimited
201    max_row_group_bytes: Option<usize>,
202
203    /// CDC chunkers persisted across row groups (one per leaf column).
204    cdc_chunkers: Option<Vec<ContentDefinedChunker>>,
205}
206
207impl<W: Write + Send> std::fmt::Debug for ArrowWriter<W> {
208    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
209        let buffered_memory = self.in_progress_size();
210        f.debug_struct("ArrowWriter")
211            .field("writer", &self.writer)
212            .field("in_progress_size", &format_args!("{buffered_memory} bytes"))
213            .field("in_progress_rows", &self.in_progress_rows())
214            .field("arrow_schema", &self.arrow_schema)
215            .field("max_row_group_row_count", &self.max_row_group_row_count)
216            .field("max_row_group_bytes", &self.max_row_group_bytes)
217            .finish()
218    }
219}
220
221impl<W: Write + Send> ArrowWriter<W> {
222    /// Try to create a new Arrow writer
223    ///
224    /// The writer will fail if:
225    ///  * a `SerializedFileWriter` cannot be created from the ParquetWriter
226    ///  * the Arrow schema contains unsupported datatypes such as Unions
227    pub fn try_new(
228        writer: W,
229        arrow_schema: SchemaRef,
230        props: Option<WriterProperties>,
231    ) -> Result<Self> {
232        let options = ArrowWriterOptions::new().with_properties(props.unwrap_or_default());
233        Self::try_new_with_options(writer, arrow_schema, options)
234    }
235
236    /// Try to create a new Arrow writer with [`ArrowWriterOptions`].
237    ///
238    /// The writer will fail if:
239    ///  * a `SerializedFileWriter` cannot be created from the ParquetWriter
240    ///  * the Arrow schema contains unsupported datatypes such as Unions
241    pub fn try_new_with_options(
242        writer: W,
243        arrow_schema: SchemaRef,
244        options: ArrowWriterOptions,
245    ) -> Result<Self> {
246        let mut props = options.properties;
247
248        let schema = if let Some(parquet_schema) = options.schema_descr {
249            parquet_schema.clone()
250        } else {
251            let mut converter = ArrowSchemaConverter::new().with_coerce_types(props.coerce_types());
252            if let Some(schema_root) = &options.schema_root {
253                converter = converter.schema_root(schema_root);
254            }
255
256            converter.convert(&arrow_schema)?
257        };
258
259        if !options.skip_arrow_metadata {
260            // add serialized arrow schema
261            add_encoded_arrow_schema_to_metadata(&arrow_schema, &mut props);
262        }
263
264        let max_row_group_row_count = props.max_row_group_row_count();
265        let max_row_group_bytes = props.max_row_group_bytes();
266
267        let props_ptr = Arc::new(props);
268        let file_writer =
269            SerializedFileWriter::new(writer, schema.root_schema_ptr(), Arc::clone(&props_ptr))?;
270
271        let mut row_group_writer_factory =
272            ArrowRowGroupWriterFactory::new(&file_writer, arrow_schema.clone());
273        if let Some(page_store_factory) = options.page_store_factory {
274            row_group_writer_factory =
275                row_group_writer_factory.with_page_store_factory(page_store_factory);
276        }
277
278        let cdc_chunkers = props_ptr
279            .content_defined_chunking()
280            .map(|opts| {
281                file_writer
282                    .schema_descr()
283                    .columns()
284                    .iter()
285                    .map(|desc| ContentDefinedChunker::new(desc, opts))
286                    .collect::<Result<Vec<_>>>()
287            })
288            .transpose()?;
289
290        Ok(Self {
291            writer: file_writer,
292            in_progress: None,
293            arrow_schema,
294            row_group_writer_factory,
295            max_row_group_row_count,
296            max_row_group_bytes,
297            cdc_chunkers,
298        })
299    }
300
301    /// Returns metadata for any flushed row groups
302    pub fn flushed_row_groups(&self) -> &[RowGroupMetaData] {
303        self.writer.flushed_row_groups()
304    }
305
306    /// Estimated memory usage, in bytes, of this `ArrowWriter`
307    ///
308    /// This estimate is formed bu summing the values of
309    /// [`ArrowColumnWriter::memory_size`] all in progress columns.
310    pub fn memory_size(&self) -> usize {
311        match &self.in_progress {
312            Some(in_progress) => in_progress.writers.iter().map(|x| x.memory_size()).sum(),
313            None => 0,
314        }
315    }
316
317    /// Anticipated encoded size of the in progress row group.
318    ///
319    /// This estimate the row group size after being completely encoded is,
320    /// formed by summing the values of
321    /// [`ArrowColumnWriter::get_estimated_total_bytes`] for all in progress
322    /// columns.
323    pub fn in_progress_size(&self) -> usize {
324        match &self.in_progress {
325            Some(in_progress) => in_progress
326                .writers
327                .iter()
328                .map(|x| x.get_estimated_total_bytes())
329                .sum(),
330            None => 0,
331        }
332    }
333
334    /// Returns the number of rows buffered in the in progress row group
335    pub fn in_progress_rows(&self) -> usize {
336        self.in_progress
337            .as_ref()
338            .map(|x| x.buffered_rows)
339            .unwrap_or_default()
340    }
341
342    /// Returns the number of bytes written by this instance
343    pub fn bytes_written(&self) -> usize {
344        self.writer.bytes_written()
345    }
346
347    /// Encodes the provided [`RecordBatch`]
348    ///
349    /// If this would cause the current row group to exceed [`WriterProperties::max_row_group_row_count`]
350    /// rows or [`WriterProperties::max_row_group_bytes`] bytes, the contents of `batch` will be
351    /// written to one or more row groups such that limits are respected.
352    ///
353    /// If both limits are `None`, all data is written to a single row group.
354    /// If one limit is set, that limit is respected.
355    /// If both limits are set, the lower bound (whichever triggers first) is respected.
356    ///
357    /// This will fail if the `batch`'s schema does not match the writer's schema.
358    pub fn write(&mut self, batch: &RecordBatch) -> Result<()> {
359        if batch.num_rows() == 0 {
360            return Ok(());
361        }
362
363        let in_progress = match &mut self.in_progress {
364            Some(in_progress) => in_progress,
365            x => x.insert(
366                self.row_group_writer_factory
367                    .create_row_group_writer(self.writer.flushed_row_groups().len())?,
368            ),
369        };
370
371        if let Some(max_rows) = self.max_row_group_row_count
372            && in_progress.buffered_rows + batch.num_rows() > max_rows
373        {
374            let to_write = max_rows - in_progress.buffered_rows;
375            let a = batch.slice(0, to_write);
376            let b = batch.slice(to_write, batch.num_rows() - to_write);
377            self.write(&a)?;
378            return self.write(&b);
379        }
380
381        // Check byte limit: if we have buffered data, use measured average row size
382        // to split batch proactively before exceeding byte limit
383        if let Some(max_bytes) = self.max_row_group_bytes
384            && in_progress.buffered_rows > 0
385        {
386            let current_bytes = in_progress.get_estimated_total_bytes();
387
388            if current_bytes >= max_bytes {
389                self.flush()?;
390                return self.write(batch);
391            }
392
393            if let Some(avg_row_bytes) = current_bytes
394                .checked_div(in_progress.buffered_rows)
395                .filter(|avg_row_bytes| *avg_row_bytes > 0)
396            {
397                // At this point, `current_bytes < max_bytes` (checked above)
398                let remaining_bytes = max_bytes - current_bytes;
399                let rows_that_fit = remaining_bytes.checked_div(avg_row_bytes).unwrap_or(0);
400
401                if batch.num_rows() > rows_that_fit {
402                    if rows_that_fit > 0 {
403                        let a = batch.slice(0, rows_that_fit);
404                        let b = batch.slice(rows_that_fit, batch.num_rows() - rows_that_fit);
405                        self.write(&a)?;
406                        return self.write(&b);
407                    } else {
408                        self.flush()?;
409                        return self.write(batch);
410                    }
411                }
412            }
413        }
414
415        match self.cdc_chunkers.as_mut() {
416            Some(chunkers) => in_progress.write_with_chunkers(batch, chunkers)?,
417            None => in_progress.write(batch)?,
418        }
419
420        let should_flush = self
421            .max_row_group_row_count
422            .is_some_and(|max| in_progress.buffered_rows >= max)
423            || self
424                .max_row_group_bytes
425                .is_some_and(|max| in_progress.get_estimated_total_bytes() >= max);
426
427        if should_flush {
428            self.flush()?
429        }
430        Ok(())
431    }
432
433    /// Writes the given buf bytes to the internal buffer.
434    ///
435    /// It's safe to use this method to write data to the underlying writer,
436    /// because it will ensure that the buffering and byte‐counting layers are used.
437    pub fn write_all(&mut self, buf: &[u8]) -> std::io::Result<()> {
438        self.writer.write_all(buf)
439    }
440
441    /// Flushes underlying writer
442    pub fn sync(&mut self) -> std::io::Result<()> {
443        self.writer.flush()
444    }
445
446    /// Flushes all buffered rows into a new row group
447    ///
448    /// Note the underlying writer is not flushed with this call.
449    /// If this is a desired behavior, please call [`ArrowWriter::sync`].
450    pub fn flush(&mut self) -> Result<()> {
451        let in_progress = match self.in_progress.take() {
452            Some(in_progress) => in_progress,
453            None => return Ok(()),
454        };
455
456        let mut row_group_writer = self.writer.next_row_group()?;
457        for chunk in in_progress.close()? {
458            chunk.append_to_row_group(&mut row_group_writer)?;
459        }
460        row_group_writer.close()?;
461        Ok(())
462    }
463
464    /// Additional [`KeyValue`] metadata to be written in addition to those from [`WriterProperties`]
465    ///
466    /// This method provide a way to append kv_metadata after write RecordBatch
467    pub fn append_key_value_metadata(&mut self, kv_metadata: KeyValue) {
468        self.writer.append_key_value_metadata(kv_metadata)
469    }
470
471    /// Returns a reference to the underlying writer.
472    pub fn inner(&self) -> &W {
473        self.writer.inner()
474    }
475
476    /// Returns a mutable reference to the underlying writer.
477    ///
478    /// **Warning**: if you write directly to this writer, you will skip
479    /// the `TrackedWrite` buffering and byte‐counting layers. That’ll cause
480    /// the file footer’s recorded offsets and sizes to diverge from reality,
481    /// resulting in an unreadable or corrupted Parquet file.
482    ///
483    /// If you want to write safely to the underlying writer, use [`Self::write_all`].
484    pub fn inner_mut(&mut self) -> &mut W {
485        self.writer.inner_mut()
486    }
487
488    /// Flushes any outstanding data and returns the underlying writer.
489    pub fn into_inner(mut self) -> Result<W> {
490        self.flush()?;
491        self.writer.into_inner()
492    }
493
494    /// Close and finalize the underlying Parquet writer
495    ///
496    /// Unlike [`Self::close`] this does not consume self
497    ///
498    /// Attempting to write after calling finish will result in an error
499    pub fn finish(&mut self) -> Result<ParquetMetaData> {
500        self.flush()?;
501        self.writer.finish()
502    }
503
504    /// Close and finalize the underlying Parquet writer
505    pub fn close(mut self) -> Result<ParquetMetaData> {
506        self.finish()
507    }
508
509    /// Converts this writer into a lower-level [`SerializedFileWriter`] and [`ArrowRowGroupWriterFactory`].
510    ///
511    /// Flushes any outstanding data before returning.
512    ///
513    /// This can be useful to provide more control over how files are written, for example
514    /// to write columns in parallel. See the example on [`ArrowColumnWriter`].
515    pub fn into_serialized_writer(
516        mut self,
517    ) -> Result<(SerializedFileWriter<W>, ArrowRowGroupWriterFactory)> {
518        self.flush()?;
519        Ok((self.writer, self.row_group_writer_factory))
520    }
521}
522
523impl<W: Write + Send> RecordBatchWriter for ArrowWriter<W> {
524    fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError> {
525        self.write(batch).map_err(|e| e.into())
526    }
527
528    fn close(self) -> std::result::Result<(), ArrowError> {
529        self.close()?;
530        Ok(())
531    }
532}
533
534/// Arrow-specific configuration settings for writing parquet files.
535///
536/// See [`ArrowWriter`] for how to configure the writer.
537#[derive(Debug, Clone, Default)]
538pub struct ArrowWriterOptions {
539    properties: WriterProperties,
540    skip_arrow_metadata: bool,
541    schema_root: Option<String>,
542    schema_descr: Option<SchemaDescriptor>,
543    page_store_factory: Option<Arc<dyn PageStoreFactory>>,
544}
545
546impl ArrowWriterOptions {
547    /// Creates a new [`ArrowWriterOptions`] with the default settings.
548    pub fn new() -> Self {
549        Self::default()
550    }
551
552    /// Sets the [`WriterProperties`] for writing parquet files.
553    pub fn with_properties(self, properties: WriterProperties) -> Self {
554        Self { properties, ..self }
555    }
556
557    /// Sets the [`PageStoreFactory`] used to buffer completed pages while a row
558    /// group is being written.
559    ///
560    /// The default implementation ([`InMemoryPageStore`]) buffers all completed
561    /// pages on the heap until the row group is flushed, so peak write memory
562    /// grows with the row group size. Using this API, pages can be spilled to a
563    /// file or object storage instead, reducing peak write memory substantially
564    /// at the expense of an extra write to and read from secondary storage.
565    ///
566    /// # Example: spilling pages to a temp file
567    ///
568    /// A simple spilling backend uses one temp file per column chunk; `put`
569    /// appends the page and `take` reads it back.
570    ///
571    /// ```
572    /// # use std::fs::File;
573    /// # use std::io::{Read, Seek, SeekFrom, Write};
574    /// # use std::sync::Arc;
575    /// # use bytes::Bytes;
576    /// # use arrow_array::{ArrayRef, Int64Array, RecordBatch};
577    /// # use parquet::arrow::arrow_writer::{
578    /// #     ArrowWriter, ArrowWriterOptions, PageKey, PageStore, PageStoreArgs, PageStoreFactory,
579    /// # };
580    /// # use parquet::arrow::arrow_reader::ParquetRecordBatchReader;
581    /// # use parquet::errors::Result;
582    /// struct TempFilePageStore {
583    ///     file: File,
584    ///     /// Total size of the file
585    ///     end: u64,
586    ///     /// Location of pages: (offset, len)
587    ///     locs: Vec<(u64, usize)>,
588    /// }
589    ///
590    /// impl PageStore for TempFilePageStore {
591    ///     fn put(&mut self, value: Bytes) -> Result<PageKey> {
592    ///         // Append to the end of the file
593    ///         self.file.seek(SeekFrom::Start(self.end))?;
594    ///         self.file.write_all(&value)?;
595    ///         let key = PageKey::new(self.locs.len() as u64);
596    ///         self.locs.push((self.end, value.len()));
597    ///         self.end += value.len() as u64;
598    ///         Ok(key)
599    ///     }
600    ///
601    ///     fn take(&mut self, key: PageKey) -> Result<Bytes> {
602    ///         let (offset, len) = self.locs[key.get() as usize];
603    ///         let mut buf = vec![0u8; len];
604    ///         self.file.seek(SeekFrom::Start(offset))?;
605    ///         self.file.read_exact(&mut buf)?;
606    ///         Ok(Bytes::from(buf))
607    ///     }
608    /// }
609    ///
610    /// /// Factory for creating [`TempFilePageStore`]
611    /// #[derive(Debug)]
612    /// struct TempFilePageStoreFactory;
613    ///
614    /// impl PageStoreFactory for TempFilePageStoreFactory {
615    ///     fn create(&self, args: &PageStoreArgs<'_>) -> Result<Box<dyn PageStore>> {
616    ///         // `args` exposes the column index and descriptor (physical/logical
617    ///         // type, path), so a real backend might choose to spill only large columns.
618    ///         let _ = (args.column_index(), args.column_descriptor());
619    ///         Ok(Box::new(TempFilePageStore {
620    ///             file: tempfile::tempfile()?, // temp file is cleaned on drop
621    ///             end: 0,
622    ///             locs: Vec::new(),
623    ///         }))
624    ///     }
625    /// }
626    /// // write 1000 integers
627    /// let col = Arc::new(Int64Array::from_iter_values(0..1000)) as ArrayRef;
628    /// let to_write = RecordBatch::try_from_iter([("col", col)]).unwrap();
629    ///
630    /// let options =
631    ///     ArrowWriterOptions::new().with_page_store_factory(Arc::new(TempFilePageStoreFactory));
632    /// let mut buffer = Vec::new();
633    /// let mut writer =
634    ///     ArrowWriter::try_new_with_options(&mut buffer, to_write.schema(), options).unwrap();
635    /// writer.write(&to_write).unwrap();
636    /// writer.close().unwrap();
637    ///
638    /// // buffer now holds valid Parquet data, which can be read as normal:
639    /// let mut reader = ParquetRecordBatchReader::try_new(Bytes::from(buffer), 1024).unwrap();
640    /// assert_eq!(to_write, reader.next().unwrap().unwrap());
641    /// ```
642    pub fn with_page_store_factory(self, page_store_factory: Arc<dyn PageStoreFactory>) -> Self {
643        Self {
644            page_store_factory: Some(page_store_factory),
645            ..self
646        }
647    }
648
649    /// Skip encoding the embedded arrow metadata (defaults to `false`)
650    ///
651    /// Parquet files generated by the [`ArrowWriter`] contain embedded arrow schema
652    /// by default.
653    ///
654    /// Set `skip_arrow_metadata` to true, to skip encoding the embedded metadata.
655    pub fn with_skip_arrow_metadata(self, skip_arrow_metadata: bool) -> Self {
656        Self {
657            skip_arrow_metadata,
658            ..self
659        }
660    }
661
662    /// Set the name of the root parquet schema element (defaults to `"arrow_schema"`)
663    pub fn with_schema_root(self, schema_root: String) -> Self {
664        Self {
665            schema_root: Some(schema_root),
666            ..self
667        }
668    }
669
670    /// Explicitly specify the Parquet schema to be used
671    ///
672    /// If omitted (the default), the [`ArrowSchemaConverter`] is used to compute the
673    /// Parquet [`SchemaDescriptor`]. This may be used When the [`SchemaDescriptor`] is
674    /// already known or must be calculated using custom logic.
675    pub fn with_parquet_schema(self, schema_descr: SchemaDescriptor) -> Self {
676        Self {
677            schema_descr: Some(schema_descr),
678            ..self
679        }
680    }
681}
682
683/// A single column chunk produced by [`ArrowColumnWriter`].
684///
685/// Holds the serialized page blobs (each page's header ‖ compressed data, in
686/// write order) in a [`PageStore`], plus the handles needed to read them back,
687/// in order, when the chunk is spliced into the output file.
688struct ArrowColumnChunkData {
689    length: usize,
690    store: Box<dyn PageStore>,
691    keys: Vec<PageKey>,
692    /// Handles to the dictionary page's blobs (header then data) in the store.
693    ///
694    /// A dictionary page is produced at most once and bounded by
695    /// `dict_page_size_limit`, but it must be written *first* in the chunk even
696    /// though the data pages reach the writer before it (see
697    /// [`PageWriter::defers_dictionary_ordering`]). Its header and data are `put`
698    /// into the store like any other page — which keeps the store uniform, and
699    /// lets an oversized dictionary page spill — and their handles are held apart
700    /// so they can be emitted ahead of the data pages at splice.
701    /// Empty for non-dictionary columns.
702    dictionary_keys: Vec<PageKey>,
703    /// Serialized length of the dictionary page (0 if there is none), recorded
704    /// so the data pages can be shifted past it when offsets are rewritten to a
705    /// dictionary-first layout at splice.
706    dictionary_len: usize,
707}
708
709impl ArrowColumnChunkData {
710    fn new(store: Box<dyn PageStore>) -> Self {
711        Self {
712            length: 0,
713            store,
714            keys: Vec::new(),
715            dictionary_keys: Vec::new(),
716            dictionary_len: 0,
717        }
718    }
719
720    /// Append a data-page blob to the store, recording its handle in write
721    /// order.
722    fn push(&mut self, value: Bytes) -> Result<()> {
723        let key = self.store.put(value)?;
724        self.keys.push(key);
725        Ok(())
726    }
727
728    /// Store a dictionary-page blob (header or data) in the page store,
729    /// recording its handle (emitted first at splice) and accumulating its
730    /// serialized length.
731    fn push_dictionary(&mut self, value: Bytes) -> Result<()> {
732        self.dictionary_len += value.len();
733        let key = self.store.put(value)?;
734        self.dictionary_keys.push(key);
735        Ok(())
736    }
737
738    /// Bytes this chunk currently holds on the heap: whatever the store keeps
739    /// resident (zero for a spilling backend).
740    fn memory_size(&self) -> usize {
741        self.store.memory_size()
742    }
743}
744
745/// A streaming iterator over one column chunk's buffered page blobs, in final
746/// file order: the dictionary page (if any) first, then the data pages.
747///
748/// Each blob is taken back out of the [`PageStore`] *as it is
749/// consumed* and released immediately afterwards, so splicing a chunk into the
750/// output file never materializes more than a single page in memory at a time.
751/// This is what keeps the splice phase within the memory bound for a spilling
752/// backend (an in-memory store already holds the bytes, so it is unaffected).
753struct StreamingColumnChunkPages {
754    store: Box<dyn PageStore>,
755    /// Page handles in final file order: the dictionary page first (if any),
756    /// then the data pages.
757    keys: IntoIter<PageKey>,
758}
759
760impl StreamingColumnChunkPages {
761    fn new(data: ArrowColumnChunkData) -> Self {
762        // The dictionary page must be emitted first, ahead of the data pages,
763        // even though it was the last page produced.
764        let keys = if data.dictionary_keys.is_empty() {
765            data.keys
766        } else {
767            let mut keys = Vec::with_capacity(data.dictionary_keys.len() + data.keys.len());
768            keys.extend(data.dictionary_keys);
769            keys.extend(data.keys);
770            keys
771        };
772        Self {
773            store: data.store,
774            keys: keys.into_iter(),
775        }
776    }
777}
778
779impl Iterator for StreamingColumnChunkPages {
780    type Item = Result<Bytes>;
781
782    fn next(&mut self) -> Option<Self::Item> {
783        let key = self.keys.next()?;
784        Some(self.store.take(key))
785    }
786}
787
788/// A shared [`ArrowColumnChunkData`]
789///
790/// This allows it to be owned by [`ArrowPageWriter`] whilst allowing access via
791/// [`ArrowRowGroupWriter`] on flush, without requiring self-referential borrows
792type SharedColumnChunk = Arc<Mutex<ArrowColumnChunkData>>;
793
794struct ArrowPageWriter {
795    buffer: SharedColumnChunk,
796    #[cfg(feature = "encryption")]
797    page_encryptor: Option<PageEncryptor>,
798}
799
800impl ArrowPageWriter {
801    /// Create a page writer that buffers completed pages in `store`.
802    fn new(store: Box<dyn PageStore>) -> Self {
803        Self {
804            buffer: Arc::new(Mutex::new(ArrowColumnChunkData::new(store))),
805            #[cfg(feature = "encryption")]
806            page_encryptor: None,
807        }
808    }
809
810    #[cfg(feature = "encryption")]
811    pub fn with_encryptor(mut self, page_encryptor: Option<PageEncryptor>) -> Self {
812        self.page_encryptor = page_encryptor;
813        self
814    }
815
816    #[cfg(feature = "encryption")]
817    fn page_encryptor_mut(&mut self) -> Option<&mut PageEncryptor> {
818        self.page_encryptor.as_mut()
819    }
820
821    // Mirrors the signature of the encryption-enabled version above, so that the
822    // callers do not need a `cfg` of their own.
823    #[cfg(not(feature = "encryption"))]
824    #[expect(
825        clippy::needless_pass_by_ref_mut,
826        reason = "mirrors the encryption-enabled signature"
827    )]
828    fn page_encryptor_mut(&mut self) -> Option<&mut PageEncryptor> {
829        None
830    }
831}
832
833impl PageWriter for ArrowPageWriter {
834    fn write_page(&mut self, page: CompressedPage) -> Result<PageWriteSpec> {
835        let page = match self.page_encryptor_mut() {
836            Some(page_encryptor) => page_encryptor.encrypt_compressed_page(page)?,
837            None => page,
838        };
839
840        let page_header = page.to_thrift_header()?;
841        let header = {
842            let mut header = Vec::with_capacity(1024);
843
844            match self.page_encryptor_mut() {
845                Some(page_encryptor) => {
846                    page_encryptor.encrypt_page_header(&page_header, &mut header)?;
847                    if page.compressed_page().is_data_page() {
848                        page_encryptor.increment_page();
849                    }
850                }
851                None => {
852                    let mut protocol = ThriftCompactOutputProtocol::new(&mut header);
853                    page_header.write_thrift(&mut protocol)?;
854                }
855            };
856
857            Bytes::from(header)
858        };
859
860        let mut buf = self.buffer.try_lock().unwrap();
861
862        let data = page.compressed_page().buffer().clone();
863        let compressed_size = data.len() + header.len();
864
865        let mut spec = PageWriteSpec::new();
866        spec.page_type = page.page_type();
867        spec.num_values = page.num_values();
868        spec.uncompressed_size = page.uncompressed_size() + header.len();
869        spec.offset = buf.length as u64;
870        spec.compressed_size = compressed_size;
871        spec.bytes_written = compressed_size as u64;
872
873        buf.length += compressed_size;
874        if spec.page_type == PageType::DICTIONARY_PAGE {
875            // Recorded apart from the data pages so it is emitted first at
876            // splice — see `ArrowColumnChunkData::dictionary_keys`.
877            buf.push_dictionary(header)?;
878            buf.push_dictionary(data)?;
879        } else {
880            buf.push(header)?;
881            buf.push(data)?;
882        }
883
884        Ok(spec)
885    }
886
887    fn defers_dictionary_ordering(&self) -> bool {
888        // The Arrow chunk is buffered in full and spliced at row-group flush, so
889        // data pages may be accepted before the dictionary page and reordered
890        // then. This lets `GenericColumnWriter` stream dictionary-column data
891        // pages straight through instead of buffering them in memory.
892        true
893    }
894
895    fn buffered_memory_size(&self) -> usize {
896        // Only what is actually resident: a spilling store reports ~0 here even
897        // though the chunk's bytes have all passed through it.
898        self.buffer.try_lock().unwrap().memory_size()
899    }
900
901    fn close(&mut self) -> Result<()> {
902        Ok(())
903    }
904}
905
906/// A leaf column that can be encoded by [`ArrowColumnWriter`]
907#[derive(Debug)]
908pub struct ArrowLeafColumn(ArrayLevels);
909
910/// Computes the [`ArrowLeafColumn`] for a potentially nested [`ArrayRef`]
911///
912/// This function can be used to encode individual columns in parallel.
913/// See example on [`ArrowColumnWriter`]
914pub fn compute_leaves(field: &Field, array: &ArrayRef) -> Result<Vec<ArrowLeafColumn>> {
915    let levels = calculate_array_levels(array, field)?;
916    Ok(levels.into_iter().map(ArrowLeafColumn).collect())
917}
918
919/// The data for a single column chunk, see [`ArrowColumnWriter`]
920pub struct ArrowColumnChunk {
921    data: ArrowColumnChunkData,
922    close: ColumnCloseResult,
923}
924
925impl std::fmt::Debug for ArrowColumnChunk {
926    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
927        f.debug_struct("ArrowColumnChunk")
928            .field("length", &self.data.length)
929            .finish_non_exhaustive()
930    }
931}
932
933impl ArrowColumnChunk {
934    /// Returns the [`ColumnCloseResult`] produced when the chunk was closed.
935    ///
936    /// Exposes encoding information, collected statistics, and the optional
937    /// [`ColumnIndexMetaData`](crate::file::page_index::column_index::ColumnIndexMetaData)
938    /// / [`OffsetIndexMetaData`](crate::file::page_index::offset_index::OffsetIndexMetaData)
939    /// gathered for the column chunk.
940    pub fn close(&self) -> &ColumnCloseResult {
941        &self.close
942    }
943
944    /// Returns a mutable reference to the [`ColumnCloseResult`].
945    ///
946    /// This allows callers to mutate the close result before the chunk is
947    /// appended to a row group — for example, clearing `column_index` or
948    /// `bloom_filter` based on a dynamic rule that inspects the encodings and
949    /// collected page statistics.
950    pub fn close_mut(&mut self) -> &mut ColumnCloseResult {
951        &mut self.close
952    }
953
954    /// Splices this column's buffered pages into the row group, streaming them
955    /// back out of the [`PageStore`] one page at a time.
956    pub fn append_to_row_group<W: Write + Send>(
957        self,
958        writer: &mut SerializedRowGroupWriter<'_, W>,
959    ) -> Result<()> {
960        let ArrowColumnChunk { data, close } = self;
961
962        // The dictionary page is produced *after* the data pages on this path (so
963        // they can stream straight through) but must be written *first*, so move
964        // it ahead of the data pages in the recorded offsets before the splice.
965        let close = close.update_dictionary_location(data.dictionary_len)?;
966
967        let pages = StreamingColumnChunkPages::new(data);
968        writer.append_column_from_pages(pages, close)
969    }
970}
971
972/// Encodes [`ArrowLeafColumn`] to [`ArrowColumnChunk`]
973///
974/// `ArrowColumnWriter` instances can be created using an [`ArrowRowGroupWriterFactory`];
975///
976/// Note: This is a low-level interface for applications that require
977/// fine-grained control of encoding (e.g. encoding using multiple threads),
978/// see [`ArrowWriter`] for a higher-level interface
979///
980/// # Example: Encoding two Arrow Array's in Parallel
981/// ```
982/// // The arrow schema
983/// # use std::sync::Arc;
984/// # use arrow_array::*;
985/// # use arrow_schema::*;
986/// # use parquet::arrow::ArrowSchemaConverter;
987/// # use parquet::arrow::arrow_writer::{compute_leaves, ArrowColumnChunk, ArrowLeafColumn, ArrowRowGroupWriterFactory};
988/// # use parquet::file::properties::WriterProperties;
989/// # use parquet::file::writer::{SerializedFileWriter, SerializedRowGroupWriter};
990/// #
991/// let schema = Arc::new(Schema::new(vec![
992///     Field::new("i32", DataType::Int32, false),
993///     Field::new("f32", DataType::Float32, false),
994/// ]));
995///
996/// // Compute the parquet schema
997/// let props = Arc::new(WriterProperties::default());
998/// let parquet_schema = ArrowSchemaConverter::new()
999///   .with_coerce_types(props.coerce_types())
1000///   .convert(&schema)
1001///   .unwrap();
1002///
1003/// // Create parquet writer
1004/// let root_schema = parquet_schema.root_schema_ptr();
1005/// // write to memory in the example, but this could be a File
1006/// let mut out = Vec::with_capacity(1024);
1007/// let mut writer = SerializedFileWriter::new(&mut out, root_schema, props.clone())
1008///   .unwrap();
1009///
1010/// // Create a factory for building Arrow column writers
1011/// let row_group_factory = ArrowRowGroupWriterFactory::new(&writer, Arc::clone(&schema));
1012/// // Create column writers for the 0th row group
1013/// let col_writers = row_group_factory.create_column_writers(0).unwrap();
1014///
1015/// // Spawn a worker thread for each column
1016/// //
1017/// // Note: This is for demonstration purposes, a thread-pool e.g. rayon or tokio, would be better.
1018/// // The `map` produces an iterator of type `tuple of (thread handle, send channel)`.
1019/// let mut workers: Vec<_> = col_writers
1020///     .into_iter()
1021///     .map(|mut col_writer| {
1022///         let (send, recv) = std::sync::mpsc::channel::<ArrowLeafColumn>();
1023///         let handle = std::thread::spawn(move || {
1024///             // receive Arrays to encode via the channel
1025///             for col in recv {
1026///                 col_writer.write(&col)?;
1027///             }
1028///             // once the input is complete, close the writer
1029///             // to return the newly created ArrowColumnChunk
1030///             col_writer.close()
1031///         });
1032///         (handle, send)
1033///     })
1034///     .collect();
1035///
1036/// // Start row group
1037/// let mut row_group_writer: SerializedRowGroupWriter<'_, _> = writer
1038///   .next_row_group()
1039///   .unwrap();
1040///
1041/// // Create some example input columns to encode
1042/// let to_write = vec![
1043///     Arc::new(Int32Array::from_iter_values([1, 2, 3])) as _,
1044///     Arc::new(Float32Array::from_iter_values([1., 45., -1.])) as _,
1045/// ];
1046///
1047/// // Send the input columns to the workers
1048/// let mut worker_iter = workers.iter_mut();
1049/// for (arr, field) in to_write.iter().zip(&schema.fields) {
1050///     for leaves in compute_leaves(field, arr).unwrap() {
1051///         worker_iter.next().unwrap().1.send(leaves).unwrap();
1052///     }
1053/// }
1054///
1055/// // Wait for the workers to complete encoding, and append
1056/// // the resulting column chunks to the row group (and the file)
1057/// for (handle, send) in workers {
1058///     drop(send); // Drop send side to signal termination
1059///     // wait for the worker to send the completed chunk
1060///     let chunk: ArrowColumnChunk = handle.join().unwrap().unwrap();
1061///     chunk.append_to_row_group(&mut row_group_writer).unwrap();
1062/// }
1063/// // Close the row group which writes to the underlying file
1064/// row_group_writer.close().unwrap();
1065///
1066/// let metadata = writer.close().unwrap();
1067/// assert_eq!(metadata.file_metadata().num_rows(), 3);
1068/// ```
1069pub struct ArrowColumnWriter {
1070    writer: ArrowColumnWriterImpl,
1071    chunk: SharedColumnChunk,
1072}
1073
1074impl std::fmt::Debug for ArrowColumnWriter {
1075    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1076        f.debug_struct("ArrowColumnWriter").finish_non_exhaustive()
1077    }
1078}
1079
1080enum ArrowColumnWriterImpl {
1081    ByteArray(GenericColumnWriter<'static, ByteArrayEncoder>),
1082    Column(ColumnWriter<'static>),
1083}
1084
1085impl ArrowColumnWriter {
1086    /// Write an [`ArrowLeafColumn`]
1087    pub fn write(&mut self, col: &ArrowLeafColumn) -> Result<()> {
1088        self.write_internal(&col.0)
1089    }
1090
1091    /// Write with content-defined chunking, inserting page flushes at chunk boundaries.
1092    fn write_with_chunker(
1093        &mut self,
1094        col: &ArrowLeafColumn,
1095        chunker: &mut ContentDefinedChunker,
1096    ) -> Result<()> {
1097        let levels = &col.0;
1098        let chunks = chunker.get_arrow_chunks(
1099            levels.def_level_data().as_ref(),
1100            levels.rep_level_data().as_ref(),
1101            levels.array(),
1102        )?;
1103
1104        let num_chunks = chunks.len();
1105        for (i, chunk) in chunks.iter().enumerate() {
1106            let chunk_levels = levels.slice_for_chunk(chunk);
1107            self.write_internal(&chunk_levels)?;
1108
1109            // Add a page break after each chunk except the last
1110            if i + 1 < num_chunks {
1111                match &mut self.writer {
1112                    ArrowColumnWriterImpl::Column(c) => c.add_data_page()?,
1113                    ArrowColumnWriterImpl::ByteArray(c) => c.add_data_page()?,
1114                }
1115            }
1116        }
1117        Ok(())
1118    }
1119
1120    fn write_internal(&mut self, levels: &ArrayLevels) -> Result<()> {
1121        match &mut self.writer {
1122            ArrowColumnWriterImpl::Column(c) => {
1123                let leaf = levels.array();
1124                match leaf.as_any_dictionary_opt() {
1125                    Some(dictionary) => {
1126                        let materialized =
1127                            arrow_select::take::take(dictionary.values(), dictionary.keys(), None)?;
1128                        write_leaf(c, &materialized, levels)?
1129                    }
1130                    None => write_leaf(c, leaf, levels)?,
1131                };
1132            }
1133            ArrowColumnWriterImpl::ByteArray(c) => {
1134                write_primitive(c, levels.array().as_ref(), levels)?;
1135            }
1136        }
1137        Ok(())
1138    }
1139
1140    /// Close this column returning the written [`ArrowColumnChunk`]
1141    pub fn close(self) -> Result<ArrowColumnChunk> {
1142        let close = match self.writer {
1143            ArrowColumnWriterImpl::ByteArray(c) => c.close()?,
1144            ArrowColumnWriterImpl::Column(c) => c.close()?,
1145        };
1146        let chunk = Arc::try_unwrap(self.chunk).ok().unwrap();
1147        let data = chunk.into_inner().unwrap();
1148        Ok(ArrowColumnChunk { data, close })
1149    }
1150
1151    /// Returns the estimated total memory usage by the writer.
1152    ///
1153    /// This  [`Self::get_estimated_total_bytes`] this is an estimate
1154    /// of the current memory usage and not it's anticipated encoded size.
1155    ///
1156    /// This includes:
1157    /// 1. Data buffered in encoded form
1158    /// 2. Data buffered in un-encoded form (e.g. `usize` dictionary keys)
1159    ///
1160    /// This value should be greater than or equal to [`Self::get_estimated_total_bytes`]
1161    pub fn memory_size(&self) -> usize {
1162        match &self.writer {
1163            ArrowColumnWriterImpl::ByteArray(c) => c.memory_size(),
1164            ArrowColumnWriterImpl::Column(c) => c.memory_size(),
1165        }
1166    }
1167
1168    /// Returns the estimated total encoded bytes for this column writer.
1169    ///
1170    /// This includes:
1171    /// 1. Data buffered in encoded form
1172    /// 2. An estimate of how large the data buffered in un-encoded form would be once encoded
1173    ///
1174    /// This value should be less than or equal to [`Self::memory_size`]
1175    pub fn get_estimated_total_bytes(&self) -> usize {
1176        match &self.writer {
1177            ArrowColumnWriterImpl::ByteArray(c) => c.get_estimated_total_bytes() as _,
1178            ArrowColumnWriterImpl::Column(c) => c.get_estimated_total_bytes() as _,
1179        }
1180    }
1181}
1182
1183/// Encodes [`RecordBatch`] to a parquet row group
1184///
1185/// Note: this structure is created by [`ArrowRowGroupWriterFactory`] internally used to
1186/// create [`ArrowRowGroupWriter`]s, but it is not exposed publicly.
1187///
1188/// See the example on [`ArrowColumnWriter`] for how to encode columns in parallel
1189#[derive(Debug)]
1190struct ArrowRowGroupWriter {
1191    writers: Vec<ArrowColumnWriter>,
1192    schema: SchemaRef,
1193    buffered_rows: usize,
1194}
1195
1196impl ArrowRowGroupWriter {
1197    fn new(writers: Vec<ArrowColumnWriter>, arrow: &SchemaRef) -> Self {
1198        Self {
1199            writers,
1200            schema: arrow.clone(),
1201            buffered_rows: 0,
1202        }
1203    }
1204
1205    fn write(&mut self, batch: &RecordBatch) -> Result<()> {
1206        self.buffered_rows += batch.num_rows();
1207        let mut writers = self.writers.iter_mut();
1208        for (field, column) in self.schema.fields().iter().zip(batch.columns()) {
1209            for leaf in compute_leaves(field.as_ref(), column)? {
1210                writers.next().unwrap().write(&leaf)?;
1211            }
1212        }
1213        Ok(())
1214    }
1215
1216    fn write_with_chunkers(
1217        &mut self,
1218        batch: &RecordBatch,
1219        chunkers: &mut [ContentDefinedChunker],
1220    ) -> Result<()> {
1221        self.buffered_rows += batch.num_rows();
1222        let mut writers = self.writers.iter_mut();
1223        let mut chunkers = chunkers.iter_mut();
1224        for (field, column) in self.schema.fields().iter().zip(batch.columns()) {
1225            for leaf in compute_leaves(field.as_ref(), column)? {
1226                writers
1227                    .next()
1228                    .unwrap()
1229                    .write_with_chunker(&leaf, chunkers.next().unwrap())?;
1230            }
1231        }
1232        Ok(())
1233    }
1234
1235    /// Returns the estimated total encoded bytes for this row group
1236    fn get_estimated_total_bytes(&self) -> usize {
1237        self.writers
1238            .iter()
1239            .map(|x| x.get_estimated_total_bytes())
1240            .sum()
1241    }
1242
1243    fn close(self) -> Result<Vec<ArrowColumnChunk>> {
1244        self.writers
1245            .into_iter()
1246            .map(|writer| writer.close())
1247            .collect()
1248    }
1249}
1250
1251/// Factory that creates new column writers for each row group in the Parquet file.
1252///
1253/// You can create this structure via an [`ArrowWriter::into_serialized_writer`].
1254/// See the example on [`ArrowColumnWriter`] for how to encode columns in parallel
1255#[derive(Debug)]
1256pub struct ArrowRowGroupWriterFactory {
1257    schema: SchemaDescPtr,
1258    arrow_schema: SchemaRef,
1259    props: WriterPropertiesPtr,
1260    page_store_factory: Arc<dyn PageStoreFactory>,
1261    #[cfg(feature = "encryption")]
1262    file_encryptor: Option<Arc<FileEncryptor>>,
1263}
1264
1265impl ArrowRowGroupWriterFactory {
1266    /// Create a new [`ArrowRowGroupWriterFactory`] for the provided file writer and Arrow schema
1267    pub fn new<W: Write + Send>(
1268        file_writer: &SerializedFileWriter<W>,
1269        arrow_schema: SchemaRef,
1270    ) -> Self {
1271        let schema = Arc::clone(file_writer.schema_descr_ptr());
1272        let props = Arc::clone(file_writer.properties());
1273        Self {
1274            schema,
1275            arrow_schema,
1276            props,
1277            page_store_factory: Arc::new(InMemoryPageStoreFactory),
1278            #[cfg(feature = "encryption")]
1279            file_encryptor: file_writer.file_encryptor(),
1280        }
1281    }
1282
1283    /// Set the [`PageStoreFactory`] used to allocate the buffer for each column
1284    /// chunk, e.g. to spill completed pages to a temp file or object storage
1285    /// instead of the heap. Defaults to [`InMemoryPageStoreFactory`].
1286    pub fn with_page_store_factory(
1287        mut self,
1288        page_store_factory: Arc<dyn PageStoreFactory>,
1289    ) -> Self {
1290        self.page_store_factory = page_store_factory;
1291        self
1292    }
1293
1294    fn create_row_group_writer(&self, row_group_index: usize) -> Result<ArrowRowGroupWriter> {
1295        let writers = self.create_column_writers(row_group_index)?;
1296        Ok(ArrowRowGroupWriter::new(writers, &self.arrow_schema))
1297    }
1298
1299    /// Create column writers for a new row group, with the given row group index
1300    pub fn create_column_writers(&self, row_group_index: usize) -> Result<Vec<ArrowColumnWriter>> {
1301        let mut writers = Vec::with_capacity(self.arrow_schema.fields.len());
1302        let mut leaves = self.schema.columns().iter();
1303        let column_factory = self.column_writer_factory(row_group_index);
1304        for field in &self.arrow_schema.fields {
1305            column_factory.get_arrow_column_writer(
1306                field.data_type(),
1307                &self.props,
1308                &mut leaves,
1309                &mut writers,
1310            )?;
1311        }
1312        Ok(writers)
1313    }
1314
1315    #[cfg(feature = "encryption")]
1316    fn column_writer_factory(&self, row_group_idx: usize) -> ArrowColumnWriterFactory {
1317        ArrowColumnWriterFactory::new()
1318            .with_page_store_factory(self.page_store_factory.clone())
1319            .with_file_encryptor(row_group_idx, self.file_encryptor.clone())
1320    }
1321
1322    #[cfg(not(feature = "encryption"))]
1323    fn column_writer_factory(&self, _row_group_idx: usize) -> ArrowColumnWriterFactory {
1324        ArrowColumnWriterFactory::new().with_page_store_factory(self.page_store_factory.clone())
1325    }
1326}
1327
1328/// Creates [`ArrowColumnWriter`] instances
1329struct ArrowColumnWriterFactory {
1330    /// Allocates the per-column-chunk [`PageStore`] backing each page writer.
1331    page_store_factory: Arc<dyn PageStoreFactory>,
1332    #[cfg(feature = "encryption")]
1333    row_group_index: usize,
1334    #[cfg(feature = "encryption")]
1335    file_encryptor: Option<Arc<FileEncryptor>>,
1336}
1337
1338impl ArrowColumnWriterFactory {
1339    pub fn new() -> Self {
1340        Self {
1341            page_store_factory: Arc::new(InMemoryPageStoreFactory),
1342            #[cfg(feature = "encryption")]
1343            row_group_index: 0,
1344            #[cfg(feature = "encryption")]
1345            file_encryptor: None,
1346        }
1347    }
1348
1349    /// Use `page_store_factory` to allocate the buffer for each column chunk.
1350    pub fn with_page_store_factory(
1351        mut self,
1352        page_store_factory: Arc<dyn PageStoreFactory>,
1353    ) -> Self {
1354        self.page_store_factory = page_store_factory;
1355        self
1356    }
1357
1358    #[cfg(feature = "encryption")]
1359    pub fn with_file_encryptor(
1360        mut self,
1361        row_group_index: usize,
1362        file_encryptor: Option<Arc<FileEncryptor>>,
1363    ) -> Self {
1364        self.row_group_index = row_group_index;
1365        self.file_encryptor = file_encryptor;
1366        self
1367    }
1368
1369    #[cfg(feature = "encryption")]
1370    fn create_page_writer(
1371        &self,
1372        column_descriptor: &ColumnDescPtr,
1373        column_index: usize,
1374    ) -> Result<Box<ArrowPageWriter>> {
1375        let column_path = column_descriptor.path().string();
1376        let page_encryptor = PageEncryptor::create_if_column_encrypted(
1377            self.file_encryptor.as_ref(),
1378            self.row_group_index,
1379            column_index,
1380            &column_path,
1381        )?;
1382        let args = PageStoreArgs::new(column_index, column_descriptor);
1383        let store = self.page_store_factory.create(&args)?;
1384        Ok(Box::new(
1385            ArrowPageWriter::new(store).with_encryptor(page_encryptor),
1386        ))
1387    }
1388
1389    #[cfg(not(feature = "encryption"))]
1390    fn create_page_writer(
1391        &self,
1392        column_descriptor: &ColumnDescPtr,
1393        column_index: usize,
1394    ) -> Result<Box<ArrowPageWriter>> {
1395        let args = PageStoreArgs::new(column_index, column_descriptor);
1396        let store = self.page_store_factory.create(&args)?;
1397        Ok(Box::new(ArrowPageWriter::new(store)))
1398    }
1399
1400    /// Gets an [`ArrowColumnWriter`] for the given `data_type`, appending the
1401    /// output ColumnDesc to `leaves` and the column writers to `out`
1402    fn get_arrow_column_writer(
1403        &self,
1404        data_type: &ArrowDataType,
1405        props: &WriterPropertiesPtr,
1406        leaves: &mut Iter<'_, ColumnDescPtr>,
1407        out: &mut Vec<ArrowColumnWriter>,
1408    ) -> Result<()> {
1409        // Instantiate writers for normal columns
1410        let col = |desc: &ColumnDescPtr| -> Result<ArrowColumnWriter> {
1411            let page_writer = self.create_page_writer(desc, out.len())?;
1412            let chunk = page_writer.buffer.clone();
1413            let writer = get_column_writer(desc.clone(), props.clone(), page_writer);
1414            Ok(ArrowColumnWriter {
1415                chunk,
1416                writer: ArrowColumnWriterImpl::Column(writer),
1417            })
1418        };
1419
1420        // Instantiate writers for byte arrays (e.g. Utf8,  Binary, etc)
1421        let bytes = |desc: &ColumnDescPtr| -> Result<ArrowColumnWriter> {
1422            let page_writer = self.create_page_writer(desc, out.len())?;
1423            let chunk = page_writer.buffer.clone();
1424            let writer = GenericColumnWriter::new(desc.clone(), props.clone(), page_writer);
1425            Ok(ArrowColumnWriter {
1426                chunk,
1427                writer: ArrowColumnWriterImpl::ByteArray(writer),
1428            })
1429        };
1430
1431        match data_type {
1432            _ if data_type.is_primitive() => out.push(col(leaves.next().unwrap())?),
1433            ArrowDataType::FixedSizeBinary(_) | ArrowDataType::Boolean | ArrowDataType::Null => {
1434                out.push(col(leaves.next().unwrap())?)
1435            }
1436            ArrowDataType::LargeBinary
1437            | ArrowDataType::Binary
1438            | ArrowDataType::Utf8
1439            | ArrowDataType::LargeUtf8
1440            | ArrowDataType::BinaryView
1441            | ArrowDataType::Utf8View => out.push(bytes(leaves.next().unwrap())?),
1442            ArrowDataType::List(f)
1443            | ArrowDataType::LargeList(f)
1444            | ArrowDataType::FixedSizeList(f, _)
1445            | ArrowDataType::ListView(f)
1446            | ArrowDataType::LargeListView(f) => {
1447                self.get_arrow_column_writer(f.data_type(), props, leaves, out)?
1448            }
1449            ArrowDataType::Struct(fields) => {
1450                for field in fields {
1451                    self.get_arrow_column_writer(field.data_type(), props, leaves, out)?
1452                }
1453            }
1454            ArrowDataType::Map(f, _) => match f.data_type() {
1455                ArrowDataType::Struct(f) => {
1456                    self.get_arrow_column_writer(f[0].data_type(), props, leaves, out)?;
1457                    self.get_arrow_column_writer(f[1].data_type(), props, leaves, out)?
1458                }
1459                _ => unreachable!("invalid map type"),
1460            },
1461            ArrowDataType::Dictionary(_, value_type) => match value_type.as_ref() {
1462                ArrowDataType::Utf8
1463                | ArrowDataType::LargeUtf8
1464                | ArrowDataType::Binary
1465                | ArrowDataType::LargeBinary => out.push(bytes(leaves.next().unwrap())?),
1466                ArrowDataType::Utf8View | ArrowDataType::BinaryView => {
1467                    out.push(bytes(leaves.next().unwrap())?)
1468                }
1469                ArrowDataType::FixedSizeBinary(_) => out.push(bytes(leaves.next().unwrap())?),
1470                _ => out.push(col(leaves.next().unwrap())?),
1471            },
1472            ArrowDataType::RunEndEncoded(_, value_field) => {
1473                self.get_arrow_column_writer(value_field.data_type(), props, leaves, out)?
1474            }
1475            _ => {
1476                return Err(ParquetError::NYI(format!(
1477                    "Attempting to write an Arrow type {data_type} to parquet that is not yet implemented"
1478                )));
1479            }
1480        }
1481        Ok(())
1482    }
1483}
1484
1485fn write_leaf(
1486    writer: &mut ColumnWriter<'_>,
1487    column: &dyn arrow_array::Array,
1488    levels: &ArrayLevels,
1489) -> Result<usize> {
1490    let indices = levels.non_null_indices();
1491
1492    match writer {
1493        // Note: this should match the contents of arrow_to_parquet_type
1494        ColumnWriter::Int32ColumnWriter(typed) => {
1495            match column.data_type() {
1496                ArrowDataType::Null => {
1497                    let array = Int32Array::new_null(column.len());
1498                    write_primitive(typed, array.values(), levels)
1499                }
1500                ArrowDataType::Int8 => {
1501                    let array: Int32Array = column.as_primitive::<Int8Type>().unary(|x| x as i32);
1502                    write_primitive(typed, array.values(), levels)
1503                }
1504                ArrowDataType::Int16 => {
1505                    let array: Int32Array = column.as_primitive::<Int16Type>().unary(|x| x as i32);
1506                    write_primitive(typed, array.values(), levels)
1507                }
1508                ArrowDataType::Int32 => {
1509                    write_primitive(typed, column.as_primitive::<Int32Type>().values(), levels)
1510                }
1511                ArrowDataType::UInt8 => {
1512                    let array: Int32Array = column.as_primitive::<UInt8Type>().unary(|x| x as i32);
1513                    write_primitive(typed, array.values(), levels)
1514                }
1515                ArrowDataType::UInt16 => {
1516                    let array: Int32Array = column.as_primitive::<UInt16Type>().unary(|x| x as i32);
1517                    write_primitive(typed, array.values(), levels)
1518                }
1519                ArrowDataType::UInt32 => {
1520                    // follow C++ implementation and use overflow/reinterpret cast from  u32 to i32 which will map
1521                    // `(i32::MAX as u32)..u32::MAX` to `i32::MIN..0`
1522                    let array = column.as_primitive::<UInt32Type>();
1523                    write_primitive(typed, array.values().inner().typed_data(), levels)
1524                }
1525                ArrowDataType::Date32 => {
1526                    let array = column.as_primitive::<Date32Type>();
1527                    write_primitive(typed, array.values(), levels)
1528                }
1529                ArrowDataType::Time32(TimeUnit::Second) => {
1530                    let array = column.as_primitive::<Time32SecondType>();
1531                    write_primitive(typed, array.values(), levels)
1532                }
1533                ArrowDataType::Time32(TimeUnit::Millisecond) => {
1534                    let array = column.as_primitive::<Time32MillisecondType>();
1535                    write_primitive(typed, array.values(), levels)
1536                }
1537                ArrowDataType::Date64 => {
1538                    // If the column is a Date64, we truncate it
1539                    let array: Int32Array = column
1540                        .as_primitive::<Date64Type>()
1541                        .unary(|x| (x / 86_400_000) as _);
1542
1543                    write_primitive(typed, array.values(), levels)
1544                }
1545                ArrowDataType::Decimal32(_, _) => {
1546                    let array = column
1547                        .as_primitive::<Decimal32Type>()
1548                        .unary::<_, Int32Type>(|v| v);
1549                    write_primitive(typed, array.values(), levels)
1550                }
1551                ArrowDataType::Decimal64(_, _) => {
1552                    // use the int32 to represent the decimal with low precision
1553                    let array = column
1554                        .as_primitive::<Decimal64Type>()
1555                        .unary::<_, Int32Type>(|v| v as i32);
1556                    write_primitive(typed, array.values(), levels)
1557                }
1558                ArrowDataType::Decimal128(_, _) => {
1559                    // use the int32 to represent the decimal with low precision
1560                    let array = column
1561                        .as_primitive::<Decimal128Type>()
1562                        .unary::<_, Int32Type>(|v| v as i32);
1563                    write_primitive(typed, array.values(), levels)
1564                }
1565                ArrowDataType::Decimal256(_, _) => {
1566                    // use the int32 to represent the decimal with low precision
1567                    let array = column
1568                        .as_primitive::<Decimal256Type>()
1569                        .unary::<_, Int32Type>(|v| v.as_i128() as i32);
1570                    write_primitive(typed, array.values(), levels)
1571                }
1572                d => Err(ParquetError::General(format!("Cannot coerce {d} to I32"))),
1573            }
1574        }
1575        ColumnWriter::BoolColumnWriter(typed) => {
1576            let array = column.as_boolean();
1577            let values = get_bool_array_slice(array, indices.iter().copied());
1578            typed.write_batch_internal(
1579                values.as_slice(),
1580                None,
1581                levels.def_level_data().as_ref(),
1582                levels.rep_level_data().as_ref(),
1583                None,
1584                None,
1585                None,
1586            )
1587        }
1588        ColumnWriter::Int64ColumnWriter(typed) => {
1589            match column.data_type() {
1590                ArrowDataType::Date64 => {
1591                    let array = column
1592                        .as_primitive::<Date64Type>()
1593                        .reinterpret_cast::<Int64Type>();
1594
1595                    write_primitive(typed, array.values(), levels)
1596                }
1597                ArrowDataType::Int64 => {
1598                    let array = column.as_primitive::<Int64Type>();
1599                    write_primitive(typed, array.values(), levels)
1600                }
1601                ArrowDataType::UInt64 => {
1602                    let values = column.as_primitive::<UInt64Type>().values();
1603                    // follow C++ implementation and use overflow/reinterpret cast from  u64 to i64 which will map
1604                    // `(i64::MAX as u64)..u64::MAX` to `i64::MIN..0`
1605                    let array = values.inner().typed_data::<i64>();
1606                    write_primitive(typed, array, levels)
1607                }
1608                ArrowDataType::Time64(TimeUnit::Microsecond) => {
1609                    let array = column.as_primitive::<Time64MicrosecondType>();
1610                    write_primitive(typed, array.values(), levels)
1611                }
1612                ArrowDataType::Time64(TimeUnit::Nanosecond) => {
1613                    let array = column.as_primitive::<Time64NanosecondType>();
1614                    write_primitive(typed, array.values(), levels)
1615                }
1616                ArrowDataType::Timestamp(unit, _) => match unit {
1617                    TimeUnit::Second => {
1618                        let array = column.as_primitive::<TimestampSecondType>();
1619                        write_primitive(typed, array.values(), levels)
1620                    }
1621                    TimeUnit::Millisecond => {
1622                        let array = column.as_primitive::<TimestampMillisecondType>();
1623                        write_primitive(typed, array.values(), levels)
1624                    }
1625                    TimeUnit::Microsecond => {
1626                        let array = column.as_primitive::<TimestampMicrosecondType>();
1627                        write_primitive(typed, array.values(), levels)
1628                    }
1629                    TimeUnit::Nanosecond => {
1630                        let array = column.as_primitive::<TimestampNanosecondType>();
1631                        write_primitive(typed, array.values(), levels)
1632                    }
1633                },
1634                ArrowDataType::Duration(unit) => match unit {
1635                    TimeUnit::Second => {
1636                        let array = column.as_primitive::<DurationSecondType>();
1637                        write_primitive(typed, array.values(), levels)
1638                    }
1639                    TimeUnit::Millisecond => {
1640                        let array = column.as_primitive::<DurationMillisecondType>();
1641                        write_primitive(typed, array.values(), levels)
1642                    }
1643                    TimeUnit::Microsecond => {
1644                        let array = column.as_primitive::<DurationMicrosecondType>();
1645                        write_primitive(typed, array.values(), levels)
1646                    }
1647                    TimeUnit::Nanosecond => {
1648                        let array = column.as_primitive::<DurationNanosecondType>();
1649                        write_primitive(typed, array.values(), levels)
1650                    }
1651                },
1652                ArrowDataType::Decimal64(_, _) => {
1653                    let array = column
1654                        .as_primitive::<Decimal64Type>()
1655                        .reinterpret_cast::<Int64Type>();
1656                    write_primitive(typed, array.values(), levels)
1657                }
1658                ArrowDataType::Decimal128(_, _) => {
1659                    // use the int64 to represent the decimal with low precision
1660                    let array = column
1661                        .as_primitive::<Decimal128Type>()
1662                        .unary::<_, Int64Type>(|v| v as i64);
1663                    write_primitive(typed, array.values(), levels)
1664                }
1665                ArrowDataType::Decimal256(_, _) => {
1666                    // use the int64 to represent the decimal with low precision
1667                    let array = column
1668                        .as_primitive::<Decimal256Type>()
1669                        .unary::<_, Int64Type>(|v| v.as_i128() as i64);
1670                    write_primitive(typed, array.values(), levels)
1671                }
1672                d => Err(ParquetError::General(format!("Cannot coerce {d} to I64"))),
1673            }
1674        }
1675        ColumnWriter::Int96ColumnWriter(_typed) => {
1676            unreachable!("Currently unreachable because data type not supported")
1677        }
1678        ColumnWriter::FloatColumnWriter(typed) => {
1679            let array = column.as_primitive::<Float32Type>();
1680            write_primitive(typed, array.values(), levels)
1681        }
1682        ColumnWriter::DoubleColumnWriter(typed) => {
1683            let array = column.as_primitive::<Float64Type>();
1684            write_primitive(typed, array.values(), levels)
1685        }
1686        ColumnWriter::ByteArrayColumnWriter(_) => {
1687            unreachable!("should use ByteArrayWriter")
1688        }
1689        ColumnWriter::FixedLenByteArrayColumnWriter(typed) => {
1690            let bytes = match column.data_type() {
1691                ArrowDataType::Interval(interval_unit) => match interval_unit {
1692                    IntervalUnit::YearMonth => {
1693                        let array = column.as_primitive::<IntervalYearMonthType>();
1694                        get_interval_ym_array_slice(array, indices.iter().copied())
1695                    }
1696                    IntervalUnit::DayTime => {
1697                        let array = column.as_primitive::<IntervalDayTimeType>();
1698                        get_interval_dt_array_slice(array, indices.iter().copied())
1699                    }
1700                    IntervalUnit::MonthDayNano => {
1701                        return Err(ParquetError::NYI(format!(
1702                            "Attempting to write an Arrow interval type {interval_unit:?} to parquet that is not yet implemented"
1703                        )));
1704                    }
1705                },
1706                ArrowDataType::FixedSizeBinary(_) => {
1707                    let array = column.as_fixed_size_binary();
1708                    get_fsb_array_slice(array, indices.iter().copied())
1709                }
1710                ArrowDataType::Decimal32(_, _) => {
1711                    let array = column.as_primitive::<Decimal32Type>();
1712                    get_decimal_array_slice(array, indices.iter().copied())
1713                }
1714                ArrowDataType::Decimal64(_, _) => {
1715                    let array = column.as_primitive::<Decimal64Type>();
1716                    get_decimal_array_slice(array, indices.iter().copied())
1717                }
1718                ArrowDataType::Decimal128(_, _) => {
1719                    let array = column.as_primitive::<Decimal128Type>();
1720                    get_decimal_array_slice(array, indices.iter().copied())
1721                }
1722                ArrowDataType::Decimal256(_, _) => {
1723                    let array = column.as_primitive::<Decimal256Type>();
1724                    get_decimal_array_slice(array, indices.iter().copied())
1725                }
1726                ArrowDataType::Float16 => {
1727                    let array = column.as_primitive::<Float16Type>();
1728                    get_float_16_array_slice(array, indices.iter().copied())
1729                }
1730                _ => {
1731                    return Err(ParquetError::NYI(
1732                        "Attempting to write an Arrow type that is not yet implemented".to_string(),
1733                    ));
1734                }
1735            };
1736            typed.write_batch_internal(
1737                bytes.as_slice(),
1738                None,
1739                levels.def_level_data().as_ref(),
1740                levels.rep_level_data().as_ref(),
1741                None,
1742                None,
1743                None,
1744            )
1745        }
1746    }
1747}
1748
1749fn write_primitive<E: ColumnValueEncoder>(
1750    writer: &mut GenericColumnWriter<E>,
1751    values: &E::Values,
1752    levels: &ArrayLevels,
1753) -> Result<usize> {
1754    writer.write_batch_internal(
1755        values,
1756        Some(levels.non_null_indices()),
1757        levels.def_level_data().as_ref(),
1758        levels.rep_level_data().as_ref(),
1759        None,
1760        None,
1761        None,
1762    )
1763}
1764
1765fn get_bool_array_slice(
1766    array: &arrow_array::BooleanArray,
1767    indices: impl ExactSizeIterator<Item = usize>,
1768) -> Vec<bool> {
1769    let mut values = Vec::with_capacity(indices.len());
1770    for i in indices {
1771        values.push(array.value(i))
1772    }
1773    values
1774}
1775
1776/// Returns 12-byte values representing 3 values of months, days and milliseconds (4-bytes each).
1777/// An Arrow YearMonth interval only stores months, thus only the first 4 bytes are populated.
1778fn get_interval_ym_array_slice(
1779    array: &arrow_array::IntervalYearMonthArray,
1780    indices: impl ExactSizeIterator<Item = usize>,
1781) -> Vec<FixedLenByteArray> {
1782    chunk_array_slice(12, indices, move |i, chunk| {
1783        let value = array.value(i);
1784        chunk[0..4].copy_from_slice(&value.to_le_bytes());
1785    })
1786}
1787
1788/// Returns 12-byte values representing 3 values of months, days and milliseconds (4-bytes each).
1789/// An Arrow DayTime interval only stores days and millis, thus the first 4 bytes are not populated.
1790fn get_interval_dt_array_slice(
1791    array: &arrow_array::IntervalDayTimeArray,
1792    indices: impl ExactSizeIterator<Item = usize>,
1793) -> Vec<FixedLenByteArray> {
1794    chunk_array_slice(12, indices, move |i, chunk| {
1795        let value = array.value(i);
1796        chunk[4..8].copy_from_slice(&value.days.to_le_bytes());
1797        chunk[8..12].copy_from_slice(&value.milliseconds.to_le_bytes());
1798    })
1799}
1800
1801trait NativeDecimalType: DecimalType {
1802    type NativeBytes: AsRef<[u8]>;
1803
1804    fn to_be_bytes(value: Self::Native) -> Self::NativeBytes;
1805}
1806impl NativeDecimalType for Decimal32Type {
1807    type NativeBytes = [u8; Self::BYTE_LENGTH];
1808
1809    fn to_be_bytes(value: Self::Native) -> Self::NativeBytes {
1810        value.to_be_bytes()
1811    }
1812}
1813impl NativeDecimalType for Decimal64Type {
1814    type NativeBytes = [u8; Self::BYTE_LENGTH];
1815
1816    fn to_be_bytes(value: Self::Native) -> Self::NativeBytes {
1817        value.to_be_bytes()
1818    }
1819}
1820impl NativeDecimalType for Decimal128Type {
1821    type NativeBytes = [u8; Self::BYTE_LENGTH];
1822
1823    fn to_be_bytes(value: Self::Native) -> Self::NativeBytes {
1824        value.to_be_bytes()
1825    }
1826}
1827impl NativeDecimalType for Decimal256Type {
1828    type NativeBytes = [u8; Self::BYTE_LENGTH];
1829
1830    fn to_be_bytes(value: Self::Native) -> Self::NativeBytes {
1831        value.to_be_bytes()
1832    }
1833}
1834
1835fn get_decimal_array_slice<T: NativeDecimalType>(
1836    array: &PrimitiveArray<T>,
1837    indices: impl ExactSizeIterator<Item = usize>,
1838) -> Vec<FixedLenByteArray> {
1839    let chunk_size = decimal_length_from_precision(array.precision());
1840    assert!(chunk_size <= T::BYTE_LENGTH);
1841
1842    if chunk_size == T::BYTE_LENGTH {
1843        // Special-case that allows inlining memcpy.
1844        chunk_array_slice(chunk_size, indices, move |i, chunk| {
1845            let as_be_bytes = T::to_be_bytes(array.value(i));
1846            chunk.copy_from_slice(as_be_bytes.as_ref());
1847        })
1848    } else {
1849        chunk_array_slice(chunk_size, indices, move |i, chunk| {
1850            let as_be_bytes = T::to_be_bytes(array.value(i));
1851            let resized_value = &as_be_bytes.as_ref()[(T::BYTE_LENGTH - chunk.len())..];
1852            chunk.copy_from_slice(resized_value);
1853        })
1854    }
1855}
1856
1857fn get_float_16_array_slice(
1858    array: &arrow_array::Float16Array,
1859    indices: impl ExactSizeIterator<Item = usize>,
1860) -> Vec<FixedLenByteArray> {
1861    chunk_array_slice(2, indices, move |i, chunk| {
1862        let value = array.value(i).to_le_bytes();
1863        chunk.copy_from_slice(&value);
1864    })
1865}
1866
1867fn get_fsb_array_slice(
1868    array: &arrow_array::FixedSizeBinaryArray,
1869    indices: impl ExactSizeIterator<Item = usize>,
1870) -> Vec<FixedLenByteArray> {
1871    chunk_array_slice(array.value_size(), indices, move |i, chunk| {
1872        let value = array.value(i);
1873        chunk.copy_from_slice(value);
1874    })
1875}
1876
1877#[inline]
1878fn chunk_array_slice(
1879    chunk_size: usize,
1880    indices: impl ExactSizeIterator<Item = usize>,
1881    writer: impl Fn(usize, &mut [u8]),
1882) -> Vec<FixedLenByteArray> {
1883    let capacity = indices.len() * chunk_size;
1884    // TODO: This could be done with Vec::spare_capacity_mut,
1885    //       but [MaybeUninit]::write_copy_of_slice is gated behind MSRV 1.93
1886    let mut arena = vec![0; capacity];
1887    for (i, chunk) in indices.zip(arena.chunks_exact_mut(chunk_size)) {
1888        writer(i, chunk);
1889    }
1890    chunk_contiguous_vec(arena, chunk_size)
1891}
1892
1893fn chunk_contiguous_vec(arena: Vec<u8>, chunk_size: usize) -> Vec<FixedLenByteArray> {
1894    let mut values = Vec::with_capacity(arena.len() / chunk_size);
1895    let mut arena = Bytes::from(arena);
1896    while arena.len() >= chunk_size {
1897        let slice = arena.split_to(chunk_size);
1898        values.push(FixedLenByteArray::from(ByteArray::from(slice)));
1899    }
1900    values
1901}
1902
1903#[cfg(test)]
1904mod tests {
1905    use super::*;
1906    use std::cmp::Ordering;
1907    use std::collections::HashMap;
1908
1909    use std::fs::File;
1910
1911    use crate::arrow::arrow_reader::{ParquetRecordBatchReader, ParquetRecordBatchReaderBuilder};
1912    use crate::arrow::{ARROW_SCHEMA_META_KEY, PARQUET_FIELD_ID_META_KEY};
1913    use crate::column::page::{Page, PageReader};
1914    use crate::file::metadata::thrift::PageHeader;
1915    use crate::file::page_index::column_index::ColumnIndexMetaData;
1916    use crate::file::reader::SerializedPageReader;
1917    use crate::parquet_thrift::{ReadThrift, ThriftSliceInputProtocol};
1918    use crate::schema::types::ColumnPath;
1919    use arrow::datatypes::ToByteSlice;
1920    use arrow::datatypes::{DataType, Schema};
1921    use arrow::error::Result as ArrowResult;
1922    use arrow::util::data_gen::create_random_array;
1923    use arrow::util::pretty::pretty_format_batches;
1924    use arrow::{array::*, buffer::Buffer};
1925    use arrow_buffer::{IntervalDayTime, IntervalMonthDayNano, NullBuffer, OffsetBuffer, i256};
1926    use arrow_schema::Fields;
1927    use half::f16;
1928    use num_traits::{FromPrimitive, ToPrimitive};
1929    use tempfile::tempfile;
1930
1931    use crate::basic::Encoding;
1932    use crate::data_type::AsBytes;
1933    use crate::file::metadata::{ColumnChunkMetaData, ParquetMetaData, ParquetMetaDataReader};
1934    use crate::file::properties::{
1935        BloomFilterPosition, EnabledStatistics, ReaderProperties, WriterVersion,
1936    };
1937    use crate::file::serialized_reader::ReadOptionsBuilder;
1938    use crate::file::{
1939        reader::{FileReader, SerializedFileReader},
1940        statistics::Statistics,
1941    };
1942
1943    /// A [`PageStore`] that allocates *sparse, non-contiguous* handles and keeps
1944    /// blobs in a `HashMap` — nothing like the default `Vec<Bytes>`. Used to
1945    /// prove the writer relies only on the opaque-handle contract and never on
1946    /// handles being dense `Vec` indices. Records how many blobs were stored.
1947    #[derive(Debug, Default)]
1948    struct RecordingPageStore {
1949        next: u64,
1950        blobs: HashMap<u64, Bytes>,
1951        puts: Arc<std::sync::atomic::AtomicUsize>,
1952    }
1953
1954    impl PageStore for RecordingPageStore {
1955        fn put(&mut self, value: Bytes) -> Result<PageKey> {
1956            // Deliberately non-sequential, never-zero handles.
1957            let id = 100 + self.next * 7;
1958            self.next += 1;
1959            self.puts.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
1960            self.blobs.insert(id, value);
1961            Ok(PageKey::new(id))
1962        }
1963
1964        fn take(&mut self, key: PageKey) -> Result<Bytes> {
1965            self.blobs
1966                .remove(&key.get())
1967                .ok_or_else(|| ParquetError::General(format!("missing key {}", key.get())))
1968        }
1969    }
1970
1971    #[derive(Debug)]
1972    struct RecordingPageStoreFactory {
1973        puts: Arc<std::sync::atomic::AtomicUsize>,
1974    }
1975
1976    impl PageStoreFactory for RecordingPageStoreFactory {
1977        fn create(&self, _args: &PageStoreArgs<'_>) -> Result<Box<dyn PageStore>> {
1978            Ok(Box::new(RecordingPageStore {
1979                puts: self.puts.clone(),
1980                ..Default::default()
1981            }))
1982        }
1983    }
1984
1985    /// A custom [`PageStore`] must produce byte-identical files to the in-memory
1986    /// default, across dictionary and non-dictionary columns and multiple row
1987    /// groups (so multiple store instances are exercised).
1988    #[test]
1989    fn custom_page_store_is_byte_identical_to_default() {
1990        let schema = Arc::new(Schema::new(vec![
1991            Field::new("i", DataType::Int32, true),
1992            // A low-cardinality string column to exercise the dictionary path.
1993            Field::new("s", DataType::Utf8, true),
1994        ]));
1995        let i = Int32Array::from(vec![Some(1), None, Some(3), Some(4), Some(5), Some(6)]);
1996        let s = StringArray::from(vec![
1997            Some("a"),
1998            Some("bb"),
1999            Some("a"),
2000            None,
2001            Some("bb"),
2002            Some("ccc"),
2003        ]);
2004        let batch = RecordBatch::try_new(schema.clone(), vec![Arc::new(i), Arc::new(s)]).unwrap();
2005
2006        // Small row groups so multiple column chunks (hence multiple store
2007        // instances) are produced.
2008        let props = WriterProperties::builder()
2009            .set_max_row_group_row_count(Some(3))
2010            .build();
2011
2012        let write = |factory: Option<Arc<dyn PageStoreFactory>>| {
2013            let mut buffer = Vec::new();
2014            let mut opts = ArrowWriterOptions::new().with_properties(props.clone());
2015            if let Some(factory) = factory {
2016                opts = opts.with_page_store_factory(factory);
2017            }
2018            let mut writer =
2019                ArrowWriter::try_new_with_options(&mut buffer, schema.clone(), opts).unwrap();
2020            writer.write(&batch).unwrap();
2021            writer.close().unwrap();
2022            buffer
2023        };
2024
2025        let default_bytes = write(None);
2026
2027        let puts = Arc::new(std::sync::atomic::AtomicUsize::new(0));
2028        let custom_bytes = write(Some(Arc::new(RecordingPageStoreFactory {
2029            puts: puts.clone(),
2030        })));
2031
2032        assert!(
2033            puts.load(std::sync::atomic::Ordering::Relaxed) > 0,
2034            "custom PageStore was never written to"
2035        );
2036        assert_eq!(
2037            default_bytes, custom_bytes,
2038            "a custom PageStore must produce byte-identical output to the default"
2039        );
2040    }
2041
2042    /// A dictionary-encoded column written through the deferred-ordering Arrow
2043    /// path must round-trip correctly even with the offset index disabled, when
2044    /// only the chunk-level dictionary/data page offsets are rewritten (there is
2045    /// no offset index to rebuild). Spans multiple data pages so the
2046    /// dictionary-first reordering is exercised.
2047    #[test]
2048    fn dictionary_column_round_trips_with_offset_index_disabled() {
2049        let schema = Arc::new(Schema::new(vec![Field::new("k", DataType::Int32, true)]));
2050
2051        // Low cardinality so the column stays dictionary-encoded; enough rows to
2052        // span several data pages within a single row group.
2053        let values: Vec<Option<i32>> = (0..50_000).map(|i| Some(i % 8)).collect();
2054        let array = Int32Array::from(values.clone());
2055        let batch = RecordBatch::try_new(schema.clone(), vec![Arc::new(array)]).unwrap();
2056
2057        let props = WriterProperties::builder()
2058            .set_offset_index_disabled(true)
2059            .set_data_page_row_count_limit(4096)
2060            .build();
2061        let opts = ArrowWriterOptions::new().with_properties(props);
2062
2063        let mut buffer = Vec::new();
2064        let mut writer =
2065            ArrowWriter::try_new_with_options(&mut buffer, schema.clone(), opts).unwrap();
2066        writer.write(&batch).unwrap();
2067        writer.close().unwrap();
2068
2069        let reader = ParquetRecordBatchReader::try_new(Bytes::from(buffer), values.len()).unwrap();
2070        let read: Vec<RecordBatch> = reader.collect::<ArrowResult<_>>().unwrap();
2071        let read_values: Vec<Option<i32>> = read
2072            .iter()
2073            .flat_map(|b| b.column(0).as_primitive::<Int32Type>().iter())
2074            .collect();
2075        assert_eq!(read_values, values);
2076    }
2077
2078    /// The dictionary page is routed through the [`PageStore`] like any other
2079    /// page rather than held resident in memory, so a dictionary column chunk's
2080    /// *entire* serialized size — dictionary page included — passes through the
2081    /// store.
2082    #[test]
2083    fn dictionary_page_is_routed_through_the_store() {
2084        /// A store that sums the bytes handed to `put`.
2085        #[derive(Debug, Default)]
2086        struct SizeRecordingPageStore {
2087            blobs: Vec<Bytes>,
2088            bytes_put: Arc<std::sync::atomic::AtomicUsize>,
2089        }
2090        impl PageStore for SizeRecordingPageStore {
2091            fn put(&mut self, value: Bytes) -> Result<PageKey> {
2092                self.bytes_put
2093                    .fetch_add(value.len(), std::sync::atomic::Ordering::Relaxed);
2094                let key = PageKey::new(self.blobs.len() as u64);
2095                self.blobs.push(value);
2096                Ok(key)
2097            }
2098            fn take(&mut self, key: PageKey) -> Result<Bytes> {
2099                Ok(std::mem::take(&mut self.blobs[key.get() as usize]))
2100            }
2101        }
2102        #[derive(Debug)]
2103        struct Factory {
2104            bytes_put: Arc<std::sync::atomic::AtomicUsize>,
2105        }
2106        impl PageStoreFactory for Factory {
2107            fn create(&self, _args: &PageStoreArgs<'_>) -> Result<Box<dyn PageStore>> {
2108                Ok(Box::new(SizeRecordingPageStore {
2109                    bytes_put: self.bytes_put.clone(),
2110                    ..Default::default()
2111                }))
2112            }
2113        }
2114
2115        let schema = Arc::new(Schema::new(vec![Field::new("s", DataType::Utf8, false)]));
2116        // Low cardinality keeps the column dictionary-encoded with a real,
2117        // non-empty dictionary page.
2118        let values: Vec<&str> = (0..2048)
2119            .map(|i| ["alpha", "beta", "gamma", "delta"][i % 4])
2120            .collect();
2121        let batch = RecordBatch::try_new(schema.clone(), vec![Arc::new(StringArray::from(values))])
2122            .unwrap();
2123
2124        let bytes_put = Arc::new(std::sync::atomic::AtomicUsize::new(0));
2125        let opts = ArrowWriterOptions::new().with_page_store_factory(Arc::new(Factory {
2126            bytes_put: bytes_put.clone(),
2127        }));
2128
2129        // A single batch / single column means exactly one row group and one
2130        // store instance, so the bytes it saw map to one column chunk.
2131        let mut buffer = Vec::new();
2132        let mut writer =
2133            ArrowWriter::try_new_with_options(&mut buffer, schema.clone(), opts).unwrap();
2134        writer.write(&batch).unwrap();
2135        writer.close().unwrap();
2136
2137        let reader = SerializedFileReader::new(Bytes::from(buffer)).unwrap();
2138        let column = reader.metadata().row_group(0).column(0);
2139        assert!(
2140            column.dictionary_page_offset().is_some(),
2141            "expected the column to be dictionary-encoded"
2142        );
2143
2144        // The bytes the store was handed must account for the whole chunk,
2145        // dictionary page included. Holding the dictionary page apart from the
2146        // store would make this fall short by the dictionary page's size.
2147        assert_eq!(
2148            bytes_put.load(std::sync::atomic::Ordering::Relaxed) as i64,
2149            column.compressed_size(),
2150            "the dictionary page must pass through the store like any other page"
2151        );
2152    }
2153
2154    #[test]
2155    fn arrow_writer() {
2156        // define schema
2157        let schema = Schema::new(vec![
2158            Field::new("a", DataType::Int32, false),
2159            Field::new("b", DataType::Int32, true),
2160        ]);
2161
2162        // create some data
2163        let a = Int32Array::from(vec![1, 2, 3, 4, 5]);
2164        let b = Int32Array::from(vec![Some(1), None, None, Some(4), Some(5)]);
2165
2166        // build a record batch
2167        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a), Arc::new(b)]).unwrap();
2168
2169        roundtrip(batch, Some(SMALL_SIZE / 2));
2170    }
2171
2172    fn get_bytes_after_close(schema: SchemaRef, expected_batch: &RecordBatch) -> Vec<u8> {
2173        let mut buffer = vec![];
2174
2175        let mut writer = ArrowWriter::try_new(&mut buffer, schema, None).unwrap();
2176        writer.write(expected_batch).unwrap();
2177        writer.close().unwrap();
2178
2179        buffer
2180    }
2181
2182    fn get_bytes_by_into_inner(schema: SchemaRef, expected_batch: &RecordBatch) -> Vec<u8> {
2183        let mut writer = ArrowWriter::try_new(Vec::new(), schema, None).unwrap();
2184        writer.write(expected_batch).unwrap();
2185        writer.into_inner().unwrap()
2186    }
2187
2188    #[test]
2189    fn roundtrip_bytes() {
2190        // define schema
2191        let schema = Arc::new(Schema::new(vec![
2192            Field::new("a", DataType::Int32, false),
2193            Field::new("b", DataType::Int32, true),
2194        ]));
2195
2196        // create some data
2197        let a = Int32Array::from(vec![1, 2, 3, 4, 5]);
2198        let b = Int32Array::from(vec![Some(1), None, None, Some(4), Some(5)]);
2199
2200        // build a record batch
2201        let expected_batch =
2202            RecordBatch::try_new(schema.clone(), vec![Arc::new(a), Arc::new(b)]).unwrap();
2203
2204        for buffer in [
2205            get_bytes_after_close(schema.clone(), &expected_batch),
2206            get_bytes_by_into_inner(schema, &expected_batch),
2207        ] {
2208            let cursor = Bytes::from(buffer);
2209            let mut record_batch_reader = ParquetRecordBatchReader::try_new(cursor, 1024).unwrap();
2210
2211            let actual_batch = record_batch_reader
2212                .next()
2213                .expect("No batch found")
2214                .expect("Unable to get batch");
2215
2216            assert_eq!(expected_batch.schema(), actual_batch.schema());
2217            assert_eq!(expected_batch.num_columns(), actual_batch.num_columns());
2218            assert_eq!(expected_batch.num_rows(), actual_batch.num_rows());
2219            for i in 0..expected_batch.num_columns() {
2220                let expected_data = expected_batch.column(i).to_data();
2221                let actual_data = actual_batch.column(i).to_data();
2222
2223                assert_eq!(expected_data, actual_data);
2224            }
2225        }
2226    }
2227
2228    #[test]
2229    fn arrow_writer_non_null() {
2230        let schema = Schema::new(vec![Field::new("a", DataType::Int32, false)]);
2231        let a = Int32Array::from(vec![1, 2, 3, 4, 5]);
2232
2233        RoundTripTest::new(Arc::new(a))
2234            .with_schema(Arc::new(schema))
2235            .run();
2236    }
2237
2238    #[test]
2239    fn arrow_writer_list() {
2240        // define schema
2241        let schema = Schema::new(vec![Field::new(
2242            "a",
2243            DataType::List(Arc::new(Field::new_list_field(DataType::Int32, false))),
2244            true,
2245        )]);
2246
2247        // create some data
2248        let a_values = Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
2249
2250        // Construct a buffer for value offsets, for the nested array:
2251        //  [[1], [2, 3], null, [4, 5, 6], [7, 8, 9, 10]]
2252        let a_value_offsets = arrow::buffer::Buffer::from([0, 1, 3, 3, 6, 10].to_byte_slice());
2253
2254        // Construct a list array from the above two
2255        let a_list_data = ArrayData::builder(DataType::List(Arc::new(Field::new_list_field(
2256            DataType::Int32,
2257            false,
2258        ))))
2259        .len(5)
2260        .add_buffer(a_value_offsets)
2261        .add_child_data(a_values.into_data())
2262        .null_bit_buffer(Some(Buffer::from([0b00011011])))
2263        .build()
2264        .unwrap();
2265        let a = ListArray::from(a_list_data);
2266        assert_eq!(a.null_count(), 1);
2267
2268        RoundTripTest::new(Arc::new(a))
2269            .with_schema(Arc::new(schema))
2270            .run();
2271    }
2272
2273    #[test]
2274    fn arrow_writer_list_non_null() {
2275        // define schema
2276        let schema = Schema::new(vec![Field::new(
2277            "a",
2278            DataType::List(Arc::new(Field::new_list_field(DataType::Int32, false))),
2279            false,
2280        )]);
2281
2282        // create some data
2283        let a_values = Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
2284
2285        // Construct a buffer for value offsets, for the nested array:
2286        //  [[1], [2, 3], [], [4, 5, 6], [7, 8, 9, 10]]
2287        let a_value_offsets = arrow::buffer::Buffer::from([0, 1, 3, 3, 6, 10].to_byte_slice());
2288
2289        // Construct a list array from the above two
2290        let a_list_data = ArrayData::builder(DataType::List(Arc::new(Field::new_list_field(
2291            DataType::Int32,
2292            false,
2293        ))))
2294        .len(5)
2295        .add_buffer(a_value_offsets)
2296        .add_child_data(a_values.into_data())
2297        .build()
2298        .unwrap();
2299        let a = ListArray::from(a_list_data);
2300        assert_eq!(a.null_count(), 0);
2301
2302        RoundTripTest::new(Arc::new(a))
2303            .with_schema(Arc::new(schema))
2304            .run();
2305    }
2306
2307    #[test]
2308    fn arrow_writer_list_view() {
2309        let list_field = Arc::new(Field::new_list_field(DataType::Int32, false));
2310        let schema = Schema::new(vec![Field::new(
2311            "a",
2312            DataType::ListView(list_field.clone()),
2313            true,
2314        )]);
2315
2316        //  [[1], [2, 3], null, [4, 5, 6], [7, 8, 9, 10]]
2317        let a = ListViewArray::new(
2318            list_field,
2319            vec![0, 1, 0, 3, 6].into(),
2320            vec![1, 2, 0, 3, 4].into(),
2321            Arc::new(Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10])),
2322            Some(vec![true, true, false, true, true].into()),
2323        );
2324        assert_eq!(a.null_count(), 1);
2325
2326        RoundTripTest::new(Arc::new(a))
2327            .with_schema(Arc::new(schema))
2328            .run();
2329    }
2330
2331    #[test]
2332    fn arrow_writer_list_view_non_null() {
2333        let list_field = Arc::new(Field::new_list_field(DataType::Int32, false));
2334        let schema = Schema::new(vec![Field::new(
2335            "a",
2336            DataType::ListView(list_field.clone()),
2337            false,
2338        )]);
2339
2340        //  [[1], [2, 3], [], [4, 5, 6], [7, 8, 9, 10]]
2341        let a = ListViewArray::new(
2342            list_field,
2343            vec![0, 1, 0, 3, 6].into(),
2344            vec![1, 2, 0, 3, 4].into(),
2345            Arc::new(Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10])),
2346            None,
2347        );
2348        assert_eq!(a.null_count(), 0);
2349
2350        RoundTripTest::new(Arc::new(a))
2351            .with_schema(Arc::new(schema))
2352            .run();
2353    }
2354
2355    #[test]
2356    fn arrow_writer_list_view_out_of_order() {
2357        let list_field = Arc::new(Field::new_list_field(DataType::Int32, false));
2358        let schema = Schema::new(vec![Field::new(
2359            "a",
2360            DataType::ListView(list_field.clone()),
2361            false,
2362        )]);
2363
2364        // [[1], [2, 3], [], [7, 8, 9, 10], [4, 5, 6]] - out of order offsets
2365        let a = ListViewArray::new(
2366            list_field,
2367            vec![0, 1, 0, 6, 3].into(),
2368            vec![1, 2, 0, 4, 3].into(),
2369            Arc::new(Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10])),
2370            None,
2371        );
2372        assert_eq!(a.null_count(), 0);
2373
2374        RoundTripTest::new(Arc::new(a))
2375            .with_schema(Arc::new(schema))
2376            .run();
2377    }
2378
2379    #[test]
2380    fn arrow_writer_large_list_view() {
2381        let list_field = Arc::new(Field::new_list_field(DataType::Int32, false));
2382        let schema = Schema::new(vec![Field::new(
2383            "a",
2384            DataType::LargeListView(list_field.clone()),
2385            true,
2386        )]);
2387
2388        //  [[1], [2, 3], null, [4, 5, 6], [7, 8, 9, 10]]
2389        let a = LargeListViewArray::new(
2390            list_field,
2391            vec![0i64, 1, 0, 3, 6].into(),
2392            vec![1i64, 2, 0, 3, 4].into(),
2393            Arc::new(Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10])),
2394            Some(vec![true, true, false, true, true].into()),
2395        );
2396        assert_eq!(a.null_count(), 1);
2397
2398        RoundTripTest::new(Arc::new(a))
2399            .with_schema(Arc::new(schema))
2400            .run();
2401    }
2402
2403    #[test]
2404    fn arrow_writer_list_view_with_struct() {
2405        // Test ListView containing Struct: ListView<Struct<Int32, Utf8>>
2406        let struct_fields = Fields::from(vec![
2407            Field::new("id", DataType::Int32, false),
2408            Field::new("name", DataType::Utf8, false),
2409        ]);
2410        let struct_type = DataType::Struct(struct_fields.clone());
2411        let list_field = Arc::new(Field::new("item", struct_type.clone(), false));
2412
2413        let schema = Schema::new(vec![Field::new(
2414            "a",
2415            DataType::ListView(list_field.clone()),
2416            true,
2417        )]);
2418
2419        // Create struct values
2420        let id_array = Int32Array::from(vec![1, 2, 3, 4, 5]);
2421        let name_array = StringArray::from(vec!["a", "b", "c", "d", "e"]);
2422        let struct_array = StructArray::new(
2423            struct_fields,
2424            vec![Arc::new(id_array), Arc::new(name_array)],
2425            None,
2426        );
2427
2428        // Create ListView: [{1, "a"}, {2, "b"}], null, [{3, "c"}, {4, "d"}, {5, "e"}]
2429        let list_view = ListViewArray::new(
2430            list_field,
2431            vec![0, 2, 2].into(), // offsets
2432            vec![2, 0, 3].into(), // sizes
2433            Arc::new(struct_array),
2434            Some(vec![true, false, true].into()),
2435        );
2436        assert_eq!(list_view.null_count(), 1);
2437
2438        RoundTripTest::new(Arc::new(list_view))
2439            .with_schema(Arc::new(schema))
2440            .run();
2441    }
2442
2443    #[test]
2444    fn arrow_writer_binary() {
2445        let raw_string_values = vec!["foo", "bar", "baz", "quux"];
2446        let raw_binary_values = [
2447            b"foo".to_vec(),
2448            b"bar".to_vec(),
2449            b"baz".to_vec(),
2450            b"quux".to_vec(),
2451        ];
2452        let raw_binary_value_refs = raw_binary_values
2453            .iter()
2454            .map(|x| x.as_slice())
2455            .collect::<Vec<_>>();
2456
2457        let string_values = StringArray::from(raw_string_values.clone());
2458        let binary_values = BinaryArray::from(raw_binary_value_refs);
2459        assert_eq!(string_values.null_count(), 0);
2460        assert_eq!(binary_values.null_count(), 0);
2461
2462        RoundTripTest::new(Arc::new(string_values)).run();
2463        RoundTripTest::new(Arc::new(binary_values)).run();
2464    }
2465
2466    #[test]
2467    fn arrow_writer_binary_view() {
2468        let raw_string_values = vec!["foo", "bar", "large payload over 12 bytes", "lulu"];
2469        let raw_binary_values = vec![
2470            b"foo".to_vec(),
2471            b"bar".to_vec(),
2472            b"large payload over 12 bytes".to_vec(),
2473            b"lulu".to_vec(),
2474        ];
2475        let nullable_string_values =
2476            vec![Some("foo"), None, Some("large payload over 12 bytes"), None];
2477
2478        let string_view_values = StringViewArray::from(raw_string_values);
2479        let binary_view_values = BinaryViewArray::from_iter_values(raw_binary_values);
2480        let nullable_string_view_values = StringViewArray::from(nullable_string_values);
2481
2482        RoundTripTest::new(Arc::new(string_view_values)).run();
2483        RoundTripTest::new(Arc::new(binary_view_values)).run();
2484        RoundTripTest::new(Arc::new(nullable_string_view_values)).run();
2485    }
2486
2487    #[test]
2488    fn arrow_writer_binary_view_long_value() {
2489        // There is special case validation for long values (greater than 128)
2490        // 128 encodes as 0x80 0x00 0x00 0x00 in little endian, which should
2491        // trigger the long-string UTF-8 validation branch in the plain decoder.
2492        let long = "a".repeat(128);
2493        let raw_string_values = vec!["foo", long.as_str(), "bar"];
2494        let raw_binary_values = vec![b"foo".to_vec(), long.as_bytes().to_vec(), b"bar".to_vec()];
2495
2496        let string_view_values: ArrayRef = Arc::new(StringViewArray::from(raw_string_values));
2497        let binary_view_values: ArrayRef =
2498            Arc::new(BinaryViewArray::from_iter_values(raw_binary_values));
2499
2500        RoundTripTest::new(Arc::clone(&string_view_values))
2501            .with_nullable(false)
2502            .run();
2503        RoundTripTest::new(Arc::clone(&binary_view_values))
2504            .with_nullable(false)
2505            .run();
2506    }
2507
2508    fn get_decimal_batch(precision: u8, scale: i8) -> RecordBatch {
2509        let decimal_field = Field::new("a", DataType::Decimal128(precision, scale), false);
2510        let schema = Schema::new(vec![decimal_field]);
2511
2512        let decimal_values = vec![10_000, 50_000, 0, -100]
2513            .into_iter()
2514            .map(Some)
2515            .collect::<Decimal128Array>()
2516            .with_precision_and_scale(precision, scale)
2517            .unwrap();
2518
2519        RecordBatch::try_new(Arc::new(schema), vec![Arc::new(decimal_values)]).unwrap()
2520    }
2521
2522    #[test]
2523    fn arrow_writer_decimal() {
2524        // int32 to store the decimal value
2525        let batch_int32_decimal = get_decimal_batch(5, 2);
2526        roundtrip(batch_int32_decimal, Some(SMALL_SIZE / 2));
2527        // int64 to store the decimal value
2528        let batch_int64_decimal = get_decimal_batch(12, 2);
2529        roundtrip(batch_int64_decimal, Some(SMALL_SIZE / 2));
2530        // fixed_length_byte_array to store the decimal value
2531        let batch_fixed_len_byte_array_decimal = get_decimal_batch(30, 2);
2532        roundtrip(batch_fixed_len_byte_array_decimal, Some(SMALL_SIZE / 2));
2533    }
2534
2535    #[test]
2536    fn arrow_writer_complex() {
2537        // define schema
2538        let struct_field_d = Arc::new(Field::new("d", DataType::Float64, true));
2539        let struct_field_f = Arc::new(Field::new("f", DataType::Float32, true));
2540        let struct_field_g = Arc::new(Field::new_list(
2541            "g",
2542            Field::new_list_field(DataType::Int16, true),
2543            false,
2544        ));
2545        let struct_field_h = Arc::new(Field::new_list(
2546            "h",
2547            Field::new_list_field(DataType::Int16, false),
2548            true,
2549        ));
2550        let struct_field_e = Arc::new(Field::new_struct(
2551            "e",
2552            vec![
2553                struct_field_f.clone(),
2554                struct_field_g.clone(),
2555                struct_field_h.clone(),
2556            ],
2557            false,
2558        ));
2559        let schema = Schema::new(vec![
2560            Field::new("a", DataType::Int32, false),
2561            Field::new("b", DataType::Int32, true),
2562            Field::new_struct(
2563                "c",
2564                vec![struct_field_d.clone(), struct_field_e.clone()],
2565                false,
2566            ),
2567        ]);
2568
2569        // create some data
2570        let a = Int32Array::from(vec![1, 2, 3, 4, 5]);
2571        let b = Int32Array::from(vec![Some(1), None, None, Some(4), Some(5)]);
2572        let d = Float64Array::from(vec![None, None, None, Some(1.0), None]);
2573        let f = Float32Array::from(vec![Some(0.0), None, Some(333.3), None, Some(5.25)]);
2574
2575        let g_value = Int16Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
2576
2577        // Construct a buffer for value offsets, for the nested array:
2578        //  [[1], [2, 3], [], [4, 5, 6], [7, 8, 9, 10]]
2579        let g_value_offsets = arrow::buffer::Buffer::from([0, 1, 3, 3, 6, 10].to_byte_slice());
2580
2581        // Construct a list array from the above two
2582        let g_list_data = ArrayData::builder(struct_field_g.data_type().clone())
2583            .len(5)
2584            .add_buffer(g_value_offsets.clone())
2585            .add_child_data(g_value.to_data())
2586            .build()
2587            .unwrap();
2588        let g = ListArray::from(g_list_data);
2589        // The difference between g and h is that h has a null bitmap
2590        let h_list_data = ArrayData::builder(struct_field_h.data_type().clone())
2591            .len(5)
2592            .add_buffer(g_value_offsets)
2593            .add_child_data(g_value.to_data())
2594            .null_bit_buffer(Some(Buffer::from([0b00011011])))
2595            .build()
2596            .unwrap();
2597        let h = ListArray::from(h_list_data);
2598
2599        let e = StructArray::from(vec![
2600            (struct_field_f, Arc::new(f) as ArrayRef),
2601            (struct_field_g, Arc::new(g) as ArrayRef),
2602            (struct_field_h, Arc::new(h) as ArrayRef),
2603        ]);
2604
2605        let c = StructArray::from(vec![
2606            (struct_field_d, Arc::new(d) as ArrayRef),
2607            (struct_field_e, Arc::new(e) as ArrayRef),
2608        ]);
2609
2610        // build a record batch
2611        let batch = RecordBatch::try_new(
2612            Arc::new(schema),
2613            vec![Arc::new(a), Arc::new(b), Arc::new(c)],
2614        )
2615        .unwrap();
2616
2617        roundtrip(batch.clone(), Some(SMALL_SIZE / 2));
2618        roundtrip(batch, Some(SMALL_SIZE / 3));
2619    }
2620
2621    #[test]
2622    fn arrow_writer_complex_mixed() {
2623        // This test was added while investigating https://github.com/apache/arrow-rs/issues/244.
2624        // It was subsequently fixed while investigating https://github.com/apache/arrow-rs/issues/245.
2625
2626        // define schema
2627        let offset_field = Arc::new(Field::new("offset", DataType::Int32, false));
2628        let partition_field = Arc::new(Field::new("partition", DataType::Int64, true));
2629        let topic_field = Arc::new(Field::new("topic", DataType::Utf8, true));
2630        let schema = Schema::new(vec![Field::new(
2631            "some_nested_object",
2632            DataType::Struct(Fields::from(vec![
2633                offset_field.clone(),
2634                partition_field.clone(),
2635                topic_field.clone(),
2636            ])),
2637            false,
2638        )]);
2639
2640        // create some data
2641        let offset = Int32Array::from(vec![1, 2, 3, 4, 5]);
2642        let partition = Int64Array::from(vec![Some(1), None, None, Some(4), Some(5)]);
2643        let topic = StringArray::from(vec![Some("A"), None, Some("A"), Some(""), None]);
2644
2645        let some_nested_object = StructArray::from(vec![
2646            (offset_field, Arc::new(offset) as ArrayRef),
2647            (partition_field, Arc::new(partition) as ArrayRef),
2648            (topic_field, Arc::new(topic) as ArrayRef),
2649        ]);
2650
2651        // build a record batch
2652        let batch =
2653            RecordBatch::try_new(Arc::new(schema), vec![Arc::new(some_nested_object)]).unwrap();
2654
2655        roundtrip(batch, Some(SMALL_SIZE / 2));
2656    }
2657
2658    #[test]
2659    fn arrow_writer_map() {
2660        // Note: we are using the JSON Arrow reader for brevity
2661        let json_content = r#"
2662        {"stocks":{"long": "$AAA", "short": "$BBB"}}
2663        {"stocks":{"long": null, "long": "$CCC", "short": null}}
2664        {"stocks":{"hedged": "$YYY", "long": null, "short": "$D"}}
2665        "#;
2666        let entries_struct_type = DataType::Struct(Fields::from(vec![
2667            Field::new(Field::MAP_KEY_FIELD_DEFAULT_NAME, DataType::Utf8, false),
2668            Field::new(Field::MAP_VALUE_FIELD_DEFAULT_NAME, DataType::Utf8, true),
2669        ]));
2670        let stocks_field = Field::new(
2671            "stocks",
2672            DataType::Map(
2673                Arc::new(Field::new(
2674                    Field::MAP_ENTRIES_FIELD_DEFAULT_NAME,
2675                    entries_struct_type,
2676                    false,
2677                )),
2678                false,
2679            ),
2680            true,
2681        );
2682        let schema = Arc::new(Schema::new(vec![stocks_field]));
2683        let builder = arrow::json::ReaderBuilder::new(schema).with_batch_size(64);
2684        let mut reader = builder.build(std::io::Cursor::new(json_content)).unwrap();
2685
2686        let batch = reader.next().unwrap().unwrap();
2687        roundtrip(batch, None);
2688    }
2689
2690    #[test]
2691    fn arrow_writer_2_level_struct() {
2692        // tests writing <struct<struct<primitive>>
2693        let field_c = Field::new("c", DataType::Int32, true);
2694        let field_b = Field::new("b", DataType::Struct(vec![field_c].into()), true);
2695        let type_a = DataType::Struct(vec![field_b.clone()].into());
2696        let field_a = Field::new("a", type_a, true);
2697        let schema = Schema::new(vec![field_a.clone()]);
2698
2699        // create data
2700        let c = Int32Array::from(vec![Some(1), None, Some(3), None, None, Some(6)]);
2701        let b_data = ArrayDataBuilder::new(field_b.data_type().clone())
2702            .len(6)
2703            .null_bit_buffer(Some(Buffer::from([0b00100111])))
2704            .add_child_data(c.into_data())
2705            .build()
2706            .unwrap();
2707        let b = StructArray::from(b_data);
2708        let a_data = ArrayDataBuilder::new(field_a.data_type().clone())
2709            .len(6)
2710            .null_bit_buffer(Some(Buffer::from([0b00101111])))
2711            .add_child_data(b.into_data())
2712            .build()
2713            .unwrap();
2714        let a = StructArray::from(a_data);
2715
2716        assert_eq!(a.null_count(), 1);
2717        assert_eq!(a.column(0).null_count(), 2);
2718
2719        // build a racord batch
2720        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a)]).unwrap();
2721
2722        roundtrip(batch, Some(SMALL_SIZE / 2));
2723    }
2724
2725    #[test]
2726    fn arrow_writer_2_level_struct_non_null() {
2727        // tests writing <struct<struct<primitive>>
2728        let field_c = Field::new("c", DataType::Int32, false);
2729        let type_b = DataType::Struct(vec![field_c].into());
2730        let field_b = Field::new("b", type_b.clone(), false);
2731        let type_a = DataType::Struct(vec![field_b].into());
2732        let field_a = Field::new("a", type_a.clone(), false);
2733        let schema = Schema::new(vec![field_a]);
2734
2735        // create data
2736        let c = Int32Array::from(vec![1, 2, 3, 4, 5, 6]);
2737        let b_data = ArrayDataBuilder::new(type_b)
2738            .len(6)
2739            .add_child_data(c.into_data())
2740            .build()
2741            .unwrap();
2742        let b = StructArray::from(b_data);
2743        let a_data = ArrayDataBuilder::new(type_a)
2744            .len(6)
2745            .add_child_data(b.into_data())
2746            .build()
2747            .unwrap();
2748        let a = StructArray::from(a_data);
2749
2750        assert_eq!(a.null_count(), 0);
2751        assert_eq!(a.column(0).null_count(), 0);
2752
2753        // build a racord batch
2754        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a)]).unwrap();
2755
2756        roundtrip(batch, Some(SMALL_SIZE / 2));
2757    }
2758
2759    #[test]
2760    fn arrow_writer_2_level_struct_mixed_null() {
2761        // tests writing <struct<struct<primitive>>
2762        let field_c = Field::new("c", DataType::Int32, false);
2763        let type_b = DataType::Struct(vec![field_c].into());
2764        let field_b = Field::new("b", type_b.clone(), true);
2765        let type_a = DataType::Struct(vec![field_b].into());
2766        let field_a = Field::new("a", type_a.clone(), false);
2767        let schema = Schema::new(vec![field_a]);
2768
2769        // create data
2770        let c = Int32Array::from(vec![1, 2, 3, 4, 5, 6]);
2771        let b_data = ArrayDataBuilder::new(type_b)
2772            .len(6)
2773            .null_bit_buffer(Some(Buffer::from([0b00100111])))
2774            .add_child_data(c.into_data())
2775            .build()
2776            .unwrap();
2777        let b = StructArray::from(b_data);
2778        // a intentionally has no null buffer, to test that this is handled correctly
2779        let a_data = ArrayDataBuilder::new(type_a)
2780            .len(6)
2781            .add_child_data(b.into_data())
2782            .build()
2783            .unwrap();
2784        let a = StructArray::from(a_data);
2785
2786        assert_eq!(a.null_count(), 0);
2787        assert_eq!(a.column(0).null_count(), 2);
2788
2789        // build a racord batch
2790        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a)]).unwrap();
2791
2792        roundtrip(batch, Some(SMALL_SIZE / 2));
2793    }
2794
2795    #[test]
2796    fn arrow_writer_2_level_struct_mixed_null_2() {
2797        // tests writing <struct<struct<primitive>>, where the primitive columns are non-null.
2798        let field_c = Field::new("c", DataType::Int32, false);
2799        let field_d = Field::new("d", DataType::FixedSizeBinary(4), false);
2800        let field_e = Field::new(
2801            "e",
2802            DataType::Dictionary(Box::new(DataType::Int32), Box::new(DataType::Utf8)),
2803            false,
2804        );
2805
2806        let field_b = Field::new(
2807            "b",
2808            DataType::Struct(vec![field_c, field_d, field_e].into()),
2809            false,
2810        );
2811        let type_a = DataType::Struct(vec![field_b.clone()].into());
2812        let field_a = Field::new("a", type_a, true);
2813        let schema = Schema::new(vec![field_a.clone()]);
2814
2815        // create data
2816        let c = Int32Array::from_iter_values(0..6);
2817        let d = FixedSizeBinaryArray::try_from_iter(
2818            ["aaaa", "bbbb", "cccc", "dddd", "eeee", "ffff"].into_iter(),
2819        )
2820        .expect("four byte values");
2821        let e = Int32DictionaryArray::from_iter(["one", "two", "three", "four", "five", "one"]);
2822        let b_data = ArrayDataBuilder::new(field_b.data_type().clone())
2823            .len(6)
2824            .add_child_data(c.into_data())
2825            .add_child_data(d.into_data())
2826            .add_child_data(e.into_data())
2827            .build()
2828            .unwrap();
2829        let b = StructArray::from(b_data);
2830        let a_data = ArrayDataBuilder::new(field_a.data_type().clone())
2831            .len(6)
2832            .null_bit_buffer(Some(Buffer::from([0b00100101])))
2833            .add_child_data(b.into_data())
2834            .build()
2835            .unwrap();
2836        let a = StructArray::from(a_data);
2837
2838        assert_eq!(a.null_count(), 3);
2839        assert_eq!(a.column(0).null_count(), 0);
2840
2841        // build a record batch
2842        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a)]).unwrap();
2843
2844        roundtrip(batch, Some(SMALL_SIZE / 2));
2845    }
2846
2847    #[test]
2848    fn test_fixed_size_binary_in_dict() {
2849        fn test_fixed_size_binary_in_dict_inner<K>()
2850        where
2851            K: ArrowDictionaryKeyType,
2852            K::Native: FromPrimitive + ToPrimitive + TryFrom<u8>,
2853            <<K as arrow_array::ArrowPrimitiveType>::Native as TryFrom<u8>>::Error: std::fmt::Debug,
2854        {
2855            let field = Field::new(
2856                "a",
2857                DataType::Dictionary(
2858                    Box::new(K::DATA_TYPE),
2859                    Box::new(DataType::FixedSizeBinary(4)),
2860                ),
2861                false,
2862            );
2863            let schema = Schema::new(vec![field]);
2864
2865            let keys: Vec<K::Native> = vec![
2866                K::Native::try_from(0u8).unwrap(),
2867                K::Native::try_from(0u8).unwrap(),
2868                K::Native::try_from(1u8).unwrap(),
2869            ];
2870            let keys = PrimitiveArray::<K>::from_iter_values(keys);
2871            let values = FixedSizeBinaryArray::try_from_iter(
2872                vec![vec![0, 0, 0, 0], vec![1, 1, 1, 1]].into_iter(),
2873            )
2874            .unwrap();
2875
2876            let data = DictionaryArray::<K>::new(keys, Arc::new(values));
2877            let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(data)]).unwrap();
2878            roundtrip(batch, None);
2879        }
2880
2881        test_fixed_size_binary_in_dict_inner::<UInt8Type>();
2882        test_fixed_size_binary_in_dict_inner::<UInt16Type>();
2883        test_fixed_size_binary_in_dict_inner::<UInt32Type>();
2884        test_fixed_size_binary_in_dict_inner::<UInt16Type>();
2885        test_fixed_size_binary_in_dict_inner::<Int8Type>();
2886        test_fixed_size_binary_in_dict_inner::<Int16Type>();
2887        test_fixed_size_binary_in_dict_inner::<Int32Type>();
2888        test_fixed_size_binary_in_dict_inner::<Int64Type>();
2889    }
2890
2891    #[test]
2892    fn test_empty_dict() {
2893        let struct_fields = Fields::from(vec![Field::new(
2894            "dict",
2895            DataType::Dictionary(Box::new(DataType::Int32), Box::new(DataType::Utf8)),
2896            false,
2897        )]);
2898
2899        let schema = Schema::new(vec![Field::new_struct(
2900            "struct",
2901            struct_fields.clone(),
2902            true,
2903        )]);
2904        let dictionary = Arc::new(DictionaryArray::new(
2905            Int32Array::new_null(5),
2906            Arc::new(StringArray::new_null(0)),
2907        ));
2908
2909        let s = StructArray::new(
2910            struct_fields,
2911            vec![dictionary],
2912            Some(NullBuffer::new_null(5)),
2913        );
2914
2915        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(s)]).unwrap();
2916        roundtrip(batch, None);
2917    }
2918    #[test]
2919    fn arrow_writer_page_size() {
2920        let schema = Arc::new(Schema::new(vec![Field::new("col", DataType::Utf8, false)]));
2921
2922        let mut builder = StringBuilder::with_capacity(100, 329 * 10_000);
2923
2924        // Generate an array of 10 unique 10 character string
2925        for i in 0..10 {
2926            let value = i
2927                .to_string()
2928                .repeat(10)
2929                .chars()
2930                .take(10)
2931                .collect::<String>();
2932
2933            builder.append_value(value);
2934        }
2935
2936        let array = Arc::new(builder.finish());
2937
2938        let batch = RecordBatch::try_new(schema, vec![array]).unwrap();
2939
2940        let file = tempfile::tempfile().unwrap();
2941
2942        // Set everything very low so we fallback to PLAIN encoding after the first row
2943        let props = WriterProperties::builder()
2944            .set_data_page_size_limit(1)
2945            .set_dictionary_page_size_limit(1)
2946            .set_write_batch_size(1)
2947            .build();
2948
2949        let mut writer =
2950            ArrowWriter::try_new(file.try_clone().unwrap(), batch.schema(), Some(props))
2951                .expect("Unable to write file");
2952        writer.write(&batch).unwrap();
2953        writer.close().unwrap();
2954
2955        let options = ReadOptionsBuilder::new().with_page_index().build();
2956        let reader =
2957            SerializedFileReader::new_with_options(file.try_clone().unwrap(), options).unwrap();
2958
2959        let column = reader.metadata().row_group(0).columns();
2960
2961        assert_eq!(column.len(), 1);
2962
2963        // We should write one row before falling back to PLAIN encoding so there should still be a
2964        // dictionary page.
2965        assert!(
2966            column[0].dictionary_page_offset().is_some(),
2967            "Expected a dictionary page"
2968        );
2969
2970        assert!(reader.metadata().offset_index().is_some());
2971        let offset_indexes = &reader.metadata().offset_index().unwrap()[0];
2972
2973        let page_locations = offset_indexes[0].page_locations.clone();
2974
2975        // We should fallback to PLAIN encoding after the first row and our max page size is 1 bytes
2976        // so we expect one dictionary encoded page and then a page per row thereafter.
2977        assert_eq!(
2978            page_locations.len(),
2979            10,
2980            "Expected 10 pages but got {page_locations:#?}"
2981        );
2982    }
2983
2984    #[test]
2985    fn arrow_writer_float_nans() {
2986        let f16_field = Field::new("a", DataType::Float16, false);
2987        let f32_field = Field::new("b", DataType::Float32, false);
2988        let f64_field = Field::new("c", DataType::Float64, false);
2989        let schema = Schema::new(vec![f16_field, f32_field, f64_field]);
2990
2991        let f16_values = (0..MEDIUM_SIZE)
2992            .map(|i| {
2993                Some(if i % 2 == 0 {
2994                    f16::NAN
2995                } else {
2996                    f16::from_f32(i as f32)
2997                })
2998            })
2999            .collect::<Float16Array>();
3000
3001        let f32_values = (0..MEDIUM_SIZE)
3002            .map(|i| Some(if i % 2 == 0 { f32::NAN } else { i as f32 }))
3003            .collect::<Float32Array>();
3004
3005        let f64_values = (0..MEDIUM_SIZE)
3006            .map(|i| Some(if i % 2 == 0 { f64::NAN } else { i as f64 }))
3007            .collect::<Float64Array>();
3008
3009        let batch = RecordBatch::try_new(
3010            Arc::new(schema),
3011            vec![
3012                Arc::new(f16_values),
3013                Arc::new(f32_values),
3014                Arc::new(f64_values),
3015            ],
3016        )
3017        .unwrap();
3018
3019        roundtrip(batch, None);
3020    }
3021
3022    const SMALL_SIZE: usize = 7;
3023    const MEDIUM_SIZE: usize = 63;
3024
3025    // Write the batch to parquet and read it back out, ensuring
3026    // that what comes out is the same as what was written in
3027    fn roundtrip(expected_batch: RecordBatch, max_row_group_size: Option<usize>) -> Vec<Bytes> {
3028        let mut files = vec![];
3029        for version in [WriterVersion::PARQUET_1_0, WriterVersion::PARQUET_2_0] {
3030            let mut props = WriterProperties::builder().set_writer_version(version);
3031
3032            if let Some(size) = max_row_group_size {
3033                props = props.set_max_row_group_row_count(Some(size))
3034            }
3035
3036            let props = props.build();
3037            files.push(roundtrip_opts(&expected_batch, props))
3038        }
3039        files
3040    }
3041
3042    // Round trip the specified record batch with the specified writer properties,
3043    // to an in-memory file, and validate the arrays using the specified function.
3044    // Returns the in-memory file.
3045    fn roundtrip_opts_with_array_validation<F>(
3046        expected_batch: &RecordBatch,
3047        props: WriterProperties,
3048        validate: F,
3049    ) -> Bytes
3050    where
3051        F: Fn(&ArrayData, &ArrayData),
3052    {
3053        let mut file = vec![];
3054
3055        let mut writer = ArrowWriter::try_new(&mut file, expected_batch.schema(), Some(props))
3056            .expect("Unable to write file");
3057        writer.write(expected_batch).unwrap();
3058        writer.close().unwrap();
3059
3060        let file = Bytes::from(file);
3061        let mut record_batch_reader =
3062            ParquetRecordBatchReader::try_new(file.clone(), 1024).unwrap();
3063
3064        let actual_batch = record_batch_reader
3065            .next()
3066            .expect("No batch found")
3067            .expect("Unable to get batch");
3068
3069        assert_eq!(expected_batch.schema(), actual_batch.schema());
3070        assert_eq!(expected_batch.num_columns(), actual_batch.num_columns());
3071        assert_eq!(expected_batch.num_rows(), actual_batch.num_rows());
3072        for i in 0..expected_batch.num_columns() {
3073            let expected_data = expected_batch.column(i).to_data();
3074            let actual_data = actual_batch.column(i).to_data();
3075            validate(&expected_data, &actual_data);
3076        }
3077
3078        file
3079    }
3080
3081    fn roundtrip_opts(expected_batch: &RecordBatch, props: WriterProperties) -> Bytes {
3082        roundtrip_opts_with_array_validation(expected_batch, props, |a, b| {
3083            a.validate_full().expect("valid expected data");
3084            b.validate_full().expect("valid actual data");
3085            assert_eq!(a, b)
3086        })
3087    }
3088
3089    /// Round trip testing fixture:
3090    ///
3091    /// Tests based on this fixture write data to parquet and then read it back.
3092    struct RoundTripTest {
3093        values: ArrayRef,
3094        /// Optionally supplied schema
3095        schema: Option<SchemaRef>,
3096        /// If the created schema should be nullable. Defaults to true. Ignored
3097        /// if schema is set to Some.
3098        nullable: bool,
3099        bloom_filter: bool,
3100        bloom_filter_ndv: Option<u64>,
3101        bloom_filter_position: BloomFilterPosition,
3102    }
3103
3104    impl RoundTripTest {
3105        /// Create a test for round tripping values with a nullable schema
3106        fn new(values: ArrayRef) -> Self {
3107            Self {
3108                values,
3109                schema: None,
3110                nullable: true,
3111                bloom_filter: false,
3112                bloom_filter_ndv: None,
3113                bloom_filter_position: BloomFilterPosition::AfterRowGroup,
3114            }
3115        }
3116
3117        /// Set the schema
3118        fn with_schema(mut self, schema: SchemaRef) -> Self {
3119            self.schema = Some(schema);
3120            self
3121        }
3122
3123        /// Set the nullable flag
3124        fn with_nullable(mut self, nullable: bool) -> Self {
3125            self.nullable = nullable;
3126            self
3127        }
3128
3129        /// Set bloom filter
3130        fn with_bloom_filter(mut self, bloom_filter: bool) -> Self {
3131            self.bloom_filter = bloom_filter;
3132            self
3133        }
3134
3135        /// Set bloom filter max ndv
3136        fn with_bloom_filter_ndv(mut self, bloom_filter_ndv: u64) -> Self {
3137            self.bloom_filter_ndv = Some(bloom_filter_ndv);
3138            self
3139        }
3140
3141        /// Set bloom filter position
3142        fn with_bloom_filter_position(
3143            mut self,
3144            bloom_filter_position: BloomFilterPosition,
3145        ) -> Self {
3146            self.bloom_filter_position = bloom_filter_position;
3147            self
3148        }
3149
3150        /// Run the test specified by the options, returning the encoded Parquet bytes
3151        fn run(self) -> Vec<Bytes> {
3152            let RoundTripTest {
3153                values,
3154                schema,
3155                nullable,
3156                bloom_filter,
3157                bloom_filter_ndv,
3158                bloom_filter_position,
3159            } = self;
3160
3161            let schema = schema.unwrap_or_else(|| {
3162                let data_type = values.data_type().clone();
3163                Arc::new(Schema::new(vec![Field::new("col", data_type, nullable)]))
3164            });
3165
3166            let encodings = match values.data_type() {
3167                DataType::Utf8 | DataType::LargeUtf8 | DataType::Binary | DataType::LargeBinary => {
3168                    vec![
3169                        Encoding::PLAIN,
3170                        Encoding::DELTA_BYTE_ARRAY,
3171                        Encoding::DELTA_LENGTH_BYTE_ARRAY,
3172                    ]
3173                }
3174                DataType::Int64
3175                | DataType::Int32
3176                | DataType::Int16
3177                | DataType::Int8
3178                | DataType::UInt64
3179                | DataType::UInt32
3180                | DataType::UInt16
3181                | DataType::UInt8 => vec![
3182                    Encoding::PLAIN,
3183                    Encoding::DELTA_BINARY_PACKED,
3184                    Encoding::BYTE_STREAM_SPLIT,
3185                ],
3186                DataType::Float32 | DataType::Float64 => {
3187                    vec![Encoding::PLAIN, Encoding::BYTE_STREAM_SPLIT]
3188                }
3189                _ => vec![Encoding::PLAIN],
3190            };
3191
3192            let expected_batch = RecordBatch::try_new(schema, vec![values]).unwrap();
3193
3194            let row_group_sizes = [1024, SMALL_SIZE, SMALL_SIZE / 2, SMALL_SIZE / 2 + 1, 10];
3195
3196            let mut files = vec![];
3197            for dictionary_size in [0, 1, 1024] {
3198                for encoding in &encodings {
3199                    for version in [WriterVersion::PARQUET_1_0, WriterVersion::PARQUET_2_0] {
3200                        for row_group_size in row_group_sizes {
3201                            let mut builder = WriterProperties::builder()
3202                                .set_writer_version(version)
3203                                .set_max_row_group_row_count(Some(row_group_size))
3204                                .set_dictionary_enabled(dictionary_size != 0)
3205                                .set_dictionary_page_size_limit(dictionary_size.max(1))
3206                                .set_encoding(*encoding)
3207                                .set_bloom_filter_enabled(bloom_filter)
3208                                .set_bloom_filter_position(bloom_filter_position);
3209                            if let Some(ndv) = bloom_filter_ndv {
3210                                builder = builder.set_bloom_filter_max_ndv(ndv);
3211                            }
3212                            let props = builder.build();
3213
3214                            files.push(roundtrip_opts(&expected_batch, props))
3215                        }
3216                    }
3217                }
3218            }
3219            files
3220        }
3221    }
3222
3223    fn values_required<A, I>(iter: I) -> Vec<Bytes>
3224    where
3225        A: From<Vec<I::Item>> + Array + 'static,
3226        I: IntoIterator,
3227    {
3228        let raw_values: Vec<_> = iter.into_iter().collect();
3229        let values = Arc::new(A::from(raw_values));
3230        RoundTripTest::new(values).with_nullable(false).run()
3231    }
3232
3233    fn values_optional<A, I>(iter: I) -> Vec<Bytes>
3234    where
3235        A: From<Vec<Option<I::Item>>> + Array + 'static,
3236        I: IntoIterator,
3237    {
3238        let optional_raw_values: Vec<_> = iter
3239            .into_iter()
3240            .enumerate()
3241            .map(|(i, v)| if i % 2 == 0 { None } else { Some(v) })
3242            .collect();
3243        let optional_values = Arc::new(A::from(optional_raw_values));
3244        RoundTripTest::new(optional_values).run()
3245    }
3246
3247    fn required_and_optional<A, I>(iter: I)
3248    where
3249        A: From<Vec<I::Item>> + From<Vec<Option<I::Item>>> + Array + 'static,
3250        I: IntoIterator + Clone,
3251    {
3252        values_required::<A, I>(iter.clone());
3253        values_optional::<A, I>(iter);
3254    }
3255
3256    fn check_bloom_filter<T: AsBytes>(
3257        files: Vec<Bytes>,
3258        file_column: String,
3259        positive_values: Vec<T>,
3260        negative_values: Vec<T>,
3261    ) {
3262        files.into_iter().take(1).for_each(|file| {
3263            let file_reader = SerializedFileReader::new_with_options(
3264                file,
3265                ReadOptionsBuilder::new()
3266                    .with_reader_properties(
3267                        ReaderProperties::builder()
3268                            .set_read_bloom_filter(true)
3269                            .build(),
3270                    )
3271                    .build(),
3272            )
3273            .expect("Unable to open file as Parquet");
3274            let metadata = file_reader.metadata();
3275
3276            // Gets bloom filters from all row groups.
3277            let mut bloom_filters: Vec<_> = vec![];
3278            for (ri, row_group) in metadata.row_groups().iter().enumerate() {
3279                if let Some((column_index, _)) = row_group
3280                    .columns()
3281                    .iter()
3282                    .enumerate()
3283                    .find(|(_, column)| column.column_path().string() == file_column)
3284                {
3285                    let row_group_reader = file_reader
3286                        .get_row_group(ri)
3287                        .expect("Unable to read row group");
3288                    if let Some(sbbf) = row_group_reader.get_column_bloom_filter(column_index) {
3289                        bloom_filters.push(sbbf.clone());
3290                    } else {
3291                        panic!("No bloom filter for column named {file_column} found");
3292                    }
3293                } else {
3294                    panic!("No column named {file_column} found");
3295                }
3296            }
3297
3298            positive_values.iter().for_each(|value| {
3299                let found = bloom_filters.iter().find(|sbbf| sbbf.check(value));
3300                assert!(
3301                    found.is_some(),
3302                    "{}",
3303                    format!("Value {:?} should be in bloom filter", value.as_bytes())
3304                );
3305            });
3306
3307            negative_values.iter().for_each(|value| {
3308                let found = bloom_filters.iter().find(|sbbf| sbbf.check(value));
3309                assert!(
3310                    found.is_none(),
3311                    "{}",
3312                    format!("Value {:?} should not be in bloom filter", value.as_bytes())
3313                );
3314            });
3315        });
3316    }
3317
3318    #[test]
3319    fn all_null_primitive_single_column() {
3320        let values = Arc::new(Int32Array::from(vec![None; SMALL_SIZE]));
3321        RoundTripTest::new(values).run();
3322    }
3323    #[test]
3324    fn null_single_column() {
3325        let values = Arc::new(NullArray::new(SMALL_SIZE));
3326        RoundTripTest::new(values).run();
3327        // null arrays are always nullable, a test with non-nullable nulls fails
3328    }
3329
3330    #[test]
3331    fn bool_single_column() {
3332        required_and_optional::<BooleanArray, _>(
3333            [true, false].iter().cycle().copied().take(SMALL_SIZE),
3334        );
3335    }
3336
3337    #[test]
3338    fn bool_large_single_column() {
3339        let values = Arc::new(
3340            [None, Some(true), Some(false)]
3341                .iter()
3342                .cycle()
3343                .copied()
3344                .take(200_000)
3345                .collect::<BooleanArray>(),
3346        );
3347        let schema = Schema::new(vec![Field::new("col", values.data_type().clone(), true)]);
3348        let expected_batch = RecordBatch::try_new(Arc::new(schema), vec![values]).unwrap();
3349        let file = tempfile::tempfile().unwrap();
3350
3351        let mut writer =
3352            ArrowWriter::try_new(file.try_clone().unwrap(), expected_batch.schema(), None)
3353                .expect("Unable to write file");
3354        writer.write(&expected_batch).unwrap();
3355        writer.close().unwrap();
3356    }
3357
3358    #[test]
3359    fn check_page_offset_index_with_nan() {
3360        let values = Arc::new(Float64Array::from(vec![f64::NAN; 10]));
3361        let schema = Schema::new(vec![Field::new("col", DataType::Float64, true)]);
3362        let batch = RecordBatch::try_new(Arc::new(schema), vec![values]).unwrap();
3363
3364        let mut out = Vec::with_capacity(1024);
3365        let mut writer =
3366            ArrowWriter::try_new(&mut out, batch.schema(), None).expect("Unable to write file");
3367        writer.write(&batch).unwrap();
3368        let file_meta_data = writer.close().unwrap();
3369        for row_group in file_meta_data.row_groups() {
3370            for column in row_group.columns() {
3371                assert!(column.offset_index_offset().is_some());
3372                assert!(column.offset_index_length().is_some());
3373                assert!(column.column_index_offset().is_some());
3374                assert!(column.column_index_length().is_some());
3375            }
3376        }
3377        assert!(file_meta_data.column_index().is_some());
3378        if let Some(col_indexes) = file_meta_data.column_index() {
3379            for rg_idx in col_indexes {
3380                for idx in rg_idx {
3381                    assert!(idx.nan_counts().is_some());
3382                    let float_idx = match idx {
3383                        ColumnIndexMetaData::DOUBLE(idx) => idx,
3384                        _ => panic!("expected double statistics"),
3385                    };
3386                    for i in 0..idx.num_pages() as usize {
3387                        assert_eq!(float_idx.nan_count(i), Some(10));
3388                        assert_eq!(
3389                            f64::NAN.total_cmp(float_idx.min_value(i).unwrap()),
3390                            Ordering::Equal
3391                        );
3392                        assert_eq!(
3393                            f64::NAN.total_cmp(float_idx.max_value(i).unwrap()),
3394                            Ordering::Equal
3395                        );
3396                    }
3397                }
3398            }
3399        }
3400    }
3401
3402    #[test]
3403    fn check_page_offset_index_with_mixed_nan() {
3404        let schema = Arc::new(Schema::new(vec![Field::new(
3405            "col",
3406            DataType::Float64,
3407            true,
3408        )]));
3409
3410        let mut out = Vec::with_capacity(1024);
3411        let props = WriterProperties::builder()
3412            .set_data_page_row_count_limit(10)
3413            .build();
3414        let mut writer = ArrowWriter::try_new(&mut out, schema.clone(), Some(props))
3415            .expect("Unable to write file");
3416
3417        // write a page of all NaN (since batch min and max are NaN, global min/max are NaN)
3418        let values = Arc::new(Float64Array::from(vec![f64::NAN; 10]));
3419        let batch = RecordBatch::try_new(schema.clone(), vec![values]).unwrap();
3420        writer.write(&batch).unwrap();
3421
3422        // write a page of all -NaN (batch min/max is -NaN, should update global min to -NaN)
3423        let values = Arc::new(Float64Array::from(vec![-f64::NAN; 10]));
3424        let batch = RecordBatch::try_new(schema.clone(), vec![values]).unwrap();
3425        writer.write(&batch).unwrap();
3426
3427        // write a page of all 0 (non-NaN should override global min/max, now 0/0)
3428        let values = Arc::new(Float64Array::from(vec![0_f64; 10]));
3429        let batch = RecordBatch::try_new(schema.clone(), vec![values]).unwrap();
3430        writer.write(&batch).unwrap();
3431
3432        // write a mixed page (should now have min -1, max 1)
3433        let values = Arc::new(Float64Array::from(vec![
3434            -1.0,
3435            0.0,
3436            f64::NAN,
3437            -f64::NAN,
3438            1.0,
3439        ]));
3440        let batch = RecordBatch::try_new(schema.clone(), vec![values]).unwrap();
3441        writer.write(&batch).unwrap();
3442
3443        let file_meta_data = writer.close().unwrap();
3444
3445        // check the column chunk stats are correct
3446        let col_stats = file_meta_data
3447            .row_group(0)
3448            .column(0)
3449            .statistics()
3450            .expect("missing column chunk statistics");
3451
3452        assert_eq!(col_stats.nan_count_opt(), Some(22));
3453        assert_eq!(col_stats.min_bytes_opt(), Some((-1.0f64).as_bytes()));
3454        assert_eq!(col_stats.max_bytes_opt(), Some(1.0f64.as_bytes()));
3455
3456        assert!(file_meta_data.column_index().is_some());
3457        let col_idx = &file_meta_data.column_index().as_ref().unwrap()[0][0];
3458        assert_eq!(col_idx.num_pages(), 4);
3459
3460        // test each page
3461        let float_idx = match col_idx {
3462            ColumnIndexMetaData::DOUBLE(idx) => idx,
3463            _ => panic!("expected double statistics"),
3464        };
3465
3466        assert_eq!(float_idx.nan_counts, Some(vec![10, 10, 0, 2]));
3467        assert_eq!(
3468            f64::NAN.total_cmp(float_idx.min_value(0).unwrap()),
3469            Ordering::Equal
3470        );
3471        assert_eq!(
3472            f64::NAN.total_cmp(float_idx.max_value(0).unwrap()),
3473            Ordering::Equal
3474        );
3475        assert_eq!(
3476            (-f64::NAN).total_cmp(float_idx.min_value(1).unwrap()),
3477            Ordering::Equal
3478        );
3479        assert_eq!(
3480            (-f64::NAN).total_cmp(float_idx.max_value(1).unwrap()),
3481            Ordering::Equal
3482        );
3483        assert_eq!(float_idx.min_value(2), Some(&0.0));
3484        assert_eq!(float_idx.max_value(2), Some(&0.0));
3485        assert_eq!(float_idx.min_value(3), Some(&-1.0));
3486        assert_eq!(float_idx.max_value(3), Some(&1.0));
3487    }
3488
3489    #[test]
3490    fn i8_single_column() {
3491        required_and_optional::<Int8Array, _>(0..SMALL_SIZE as i8);
3492    }
3493
3494    #[test]
3495    fn i16_single_column() {
3496        required_and_optional::<Int16Array, _>(0..SMALL_SIZE as i16);
3497    }
3498
3499    #[test]
3500    fn i32_single_column() {
3501        required_and_optional::<Int32Array, _>(0..SMALL_SIZE as i32);
3502    }
3503
3504    #[test]
3505    fn i64_single_column() {
3506        required_and_optional::<Int64Array, _>(0..SMALL_SIZE as i64);
3507    }
3508
3509    #[test]
3510    fn u8_single_column() {
3511        required_and_optional::<UInt8Array, _>(0..SMALL_SIZE as u8);
3512    }
3513
3514    #[test]
3515    fn u16_single_column() {
3516        required_and_optional::<UInt16Array, _>(0..SMALL_SIZE as u16);
3517    }
3518
3519    #[test]
3520    fn u32_single_column() {
3521        required_and_optional::<UInt32Array, _>(0..SMALL_SIZE as u32);
3522    }
3523
3524    #[test]
3525    fn u64_single_column() {
3526        required_and_optional::<UInt64Array, _>(0..SMALL_SIZE as u64);
3527    }
3528
3529    #[test]
3530    fn f32_single_column() {
3531        required_and_optional::<Float32Array, _>((0..SMALL_SIZE).map(|i| i as f32));
3532    }
3533
3534    #[test]
3535    fn f64_single_column() {
3536        required_and_optional::<Float64Array, _>((0..SMALL_SIZE).map(|i| i as f64));
3537    }
3538
3539    // The timestamp array types don't implement From<Vec<T>> because they need the timezone
3540    // argument, and they also doesn't support building from a Vec<Option<T>>, so call
3541    // RoundTripTest manually instead of calling required_and_optional for these tests.
3542
3543    #[test]
3544    fn timestamp_second_single_column() {
3545        let raw_values: Vec<_> = (0..SMALL_SIZE as i64).collect();
3546        let values = Arc::new(TimestampSecondArray::from(raw_values));
3547
3548        RoundTripTest::new(values).with_nullable(false).run();
3549    }
3550
3551    #[test]
3552    fn timestamp_millisecond_single_column() {
3553        let raw_values: Vec<_> = (0..SMALL_SIZE as i64).collect();
3554        let values = Arc::new(TimestampMillisecondArray::from(raw_values));
3555
3556        RoundTripTest::new(values).with_nullable(false).run();
3557    }
3558
3559    #[test]
3560    fn timestamp_microsecond_single_column() {
3561        let raw_values: Vec<_> = (0..SMALL_SIZE as i64).collect();
3562        let values = Arc::new(TimestampMicrosecondArray::from(raw_values));
3563
3564        RoundTripTest::new(values).with_nullable(false).run();
3565    }
3566
3567    #[test]
3568    fn timestamp_nanosecond_single_column() {
3569        let raw_values: Vec<_> = (0..SMALL_SIZE as i64).collect();
3570        let values = Arc::new(TimestampNanosecondArray::from(raw_values));
3571
3572        RoundTripTest::new(values).with_nullable(false).run();
3573    }
3574
3575    #[test]
3576    fn date32_single_column() {
3577        required_and_optional::<Date32Array, _>(0..SMALL_SIZE as i32);
3578    }
3579
3580    #[test]
3581    fn date64_single_column() {
3582        // Date64 must be a multiple of 86400000, see ARROW-10925
3583        required_and_optional::<Date64Array, _>(
3584            (0..(SMALL_SIZE as i64 * 86400000)).step_by(86400000),
3585        );
3586    }
3587
3588    #[test]
3589    fn time32_second_single_column() {
3590        required_and_optional::<Time32SecondArray, _>(0..SMALL_SIZE as i32);
3591    }
3592
3593    #[test]
3594    fn time32_millisecond_single_column() {
3595        required_and_optional::<Time32MillisecondArray, _>(0..SMALL_SIZE as i32);
3596    }
3597
3598    #[test]
3599    fn time64_microsecond_single_column() {
3600        required_and_optional::<Time64MicrosecondArray, _>(0..SMALL_SIZE as i64);
3601    }
3602
3603    #[test]
3604    fn time64_nanosecond_single_column() {
3605        required_and_optional::<Time64NanosecondArray, _>(0..SMALL_SIZE as i64);
3606    }
3607
3608    #[test]
3609    fn duration_second_single_column() {
3610        required_and_optional::<DurationSecondArray, _>(0..SMALL_SIZE as i64);
3611    }
3612
3613    #[test]
3614    fn duration_millisecond_single_column() {
3615        required_and_optional::<DurationMillisecondArray, _>(0..SMALL_SIZE as i64);
3616    }
3617
3618    #[test]
3619    fn duration_microsecond_single_column() {
3620        required_and_optional::<DurationMicrosecondArray, _>(0..SMALL_SIZE as i64);
3621    }
3622
3623    #[test]
3624    fn duration_nanosecond_single_column() {
3625        required_and_optional::<DurationNanosecondArray, _>(0..SMALL_SIZE as i64);
3626    }
3627
3628    #[test]
3629    fn interval_year_month_single_column() {
3630        required_and_optional::<IntervalYearMonthArray, _>(0..SMALL_SIZE as i32);
3631    }
3632
3633    #[test]
3634    fn interval_day_time_single_column() {
3635        required_and_optional::<IntervalDayTimeArray, _>(vec![
3636            IntervalDayTime::new(0, 1),
3637            IntervalDayTime::new(0, 3),
3638            IntervalDayTime::new(3, -2),
3639            IntervalDayTime::new(-200, 4),
3640        ]);
3641    }
3642
3643    #[test]
3644    #[should_panic(
3645        expected = "Attempting to write an Arrow interval type MonthDayNano to parquet that is not yet implemented"
3646    )]
3647    fn interval_month_day_nano_single_column() {
3648        required_and_optional::<IntervalMonthDayNanoArray, _>(vec![
3649            IntervalMonthDayNano::new(0, 1, 5),
3650            IntervalMonthDayNano::new(0, 3, 2),
3651            IntervalMonthDayNano::new(3, -2, -5),
3652            IntervalMonthDayNano::new(-200, 4, -1),
3653        ]);
3654    }
3655
3656    #[test]
3657    fn binary_single_column() {
3658        let one_vec: Vec<u8> = (0..SMALL_SIZE as u8).collect();
3659        let many_vecs: Vec<_> = std::iter::repeat_n(one_vec, SMALL_SIZE).collect();
3660        let many_vecs_iter = many_vecs.iter().map(|v| v.as_slice());
3661
3662        // BinaryArrays can't be built from Vec<Option<&str>>, so only call `values_required`
3663        values_required::<BinaryArray, _>(many_vecs_iter);
3664    }
3665
3666    #[test]
3667    fn binary_view_single_column() {
3668        let one_vec: Vec<u8> = (0..SMALL_SIZE as u8).collect();
3669        let many_vecs: Vec<_> = std::iter::repeat_n(one_vec, SMALL_SIZE).collect();
3670        let many_vecs_iter = many_vecs.iter().map(|v| v.as_slice());
3671
3672        // BinaryArrays can't be built from Vec<Option<&str>>, so only call `values_required`
3673        values_required::<BinaryViewArray, _>(many_vecs_iter);
3674    }
3675
3676    #[test]
3677    fn i32_column_bloom_filter_at_end() {
3678        let array = Arc::new(Int32Array::from_iter(0..SMALL_SIZE as i32));
3679        let files = RoundTripTest::new(array)
3680            .with_nullable(false)
3681            .with_bloom_filter(true)
3682            .with_bloom_filter_position(BloomFilterPosition::End)
3683            .run();
3684
3685        check_bloom_filter(
3686            files,
3687            "col".to_string(),
3688            (0..SMALL_SIZE as i32).collect(),
3689            (SMALL_SIZE as i32 + 1..SMALL_SIZE as i32 + 10).collect(),
3690        );
3691    }
3692
3693    #[test]
3694    fn i32_column_bloom_filter() {
3695        let array = Arc::new(Int32Array::from_iter(0..SMALL_SIZE as i32));
3696        let files = RoundTripTest::new(array)
3697            .with_nullable(false)
3698            .with_bloom_filter(true)
3699            .run();
3700
3701        check_bloom_filter(
3702            files,
3703            "col".to_string(),
3704            (0..SMALL_SIZE as i32).collect(),
3705            (SMALL_SIZE as i32 + 1..SMALL_SIZE as i32 + 10).collect(),
3706        );
3707    }
3708
3709    /// Test that bloom filter folding produces correct results even when
3710    /// the configured NDV differs significantly from actual NDV.
3711    /// A large NDV means a larger initial filter that gets folded down;
3712    /// a small NDV means a smaller initial filter.
3713    #[test]
3714    fn i32_column_bloom_filter_fixed_ndv() {
3715        let array = Arc::new(Int32Array::from_iter(0..SMALL_SIZE as i32));
3716
3717        // NDV much larger than actual distinct values — tests folding a large filter down
3718        let files = RoundTripTest::new(array.clone())
3719            .with_nullable(false)
3720            .with_bloom_filter(true)
3721            .with_bloom_filter_ndv(1_000_000)
3722            .run();
3723
3724        check_bloom_filter(
3725            files,
3726            "col".to_string(),
3727            (0..SMALL_SIZE as i32).collect(),
3728            (SMALL_SIZE as i32 + 1..SMALL_SIZE as i32 + 10).collect(),
3729        );
3730
3731        // NDV smaller than actual distinct values — tests the underestimate path
3732        let files = RoundTripTest::new(array)
3733            .with_nullable(false)
3734            .with_bloom_filter(true)
3735            .with_bloom_filter_ndv(3)
3736            .run();
3737
3738        check_bloom_filter(
3739            files,
3740            "col".to_string(),
3741            (0..SMALL_SIZE as i32).collect(),
3742            (SMALL_SIZE as i32 + 1..SMALL_SIZE as i32 + 10).collect(),
3743        );
3744    }
3745
3746    #[test]
3747    fn binary_column_bloom_filter() {
3748        let one_vec: Vec<u8> = (0..SMALL_SIZE as u8).collect();
3749        let many_vecs: Vec<_> = std::iter::repeat_n(one_vec, SMALL_SIZE).collect();
3750        let many_vecs_iter = many_vecs.iter().map(|v| v.as_slice());
3751
3752        let array = Arc::new(BinaryArray::from_iter_values(many_vecs_iter));
3753        let files = RoundTripTest::new(array)
3754            .with_nullable(false)
3755            .with_bloom_filter(true)
3756            .run();
3757
3758        check_bloom_filter(
3759            files,
3760            "col".to_string(),
3761            many_vecs,
3762            vec![vec![(SMALL_SIZE + 1) as u8]],
3763        );
3764    }
3765
3766    #[test]
3767    fn empty_string_null_column_bloom_filter() {
3768        let raw_values: Vec<_> = (0..SMALL_SIZE).map(|i| i.to_string()).collect();
3769        let raw_strs = raw_values.iter().map(|s| s.as_str());
3770
3771        let array = Arc::new(StringArray::from_iter_values(raw_strs));
3772        let files = RoundTripTest::new(array)
3773            .with_nullable(false)
3774            .with_bloom_filter(true)
3775            .run();
3776
3777        let optional_raw_values: Vec<_> = raw_values
3778            .iter()
3779            .enumerate()
3780            .filter_map(|(i, v)| if i % 2 == 0 { None } else { Some(v.as_str()) })
3781            .collect();
3782        // For null slots, empty string should not be in bloom filter.
3783        check_bloom_filter(files, "col".to_string(), optional_raw_values, vec![""]);
3784    }
3785
3786    #[test]
3787    fn large_binary_single_column() {
3788        let one_vec: Vec<u8> = (0..SMALL_SIZE as u8).collect();
3789        let many_vecs: Vec<_> = std::iter::repeat_n(one_vec, SMALL_SIZE).collect();
3790        let many_vecs_iter = many_vecs.iter().map(|v| v.as_slice());
3791
3792        // LargeBinaryArrays can't be built from Vec<Option<&str>>, so only call `values_required`
3793        values_required::<LargeBinaryArray, _>(many_vecs_iter);
3794    }
3795
3796    #[test]
3797    fn fixed_size_binary_single_column() {
3798        let mut builder = FixedSizeBinaryBuilder::new(4);
3799        builder.append_value(b"0123").unwrap();
3800        builder.append_null();
3801        builder.append_value(b"8910").unwrap();
3802        builder.append_value(b"1112").unwrap();
3803        let array = Arc::new(builder.finish());
3804
3805        RoundTripTest::new(array).run();
3806    }
3807
3808    #[test]
3809    fn string_single_column() {
3810        let raw_values: Vec<_> = (0..SMALL_SIZE).map(|i| i.to_string()).collect();
3811        let raw_strs = raw_values.iter().map(|s| s.as_str());
3812
3813        required_and_optional::<StringArray, _>(raw_strs);
3814    }
3815
3816    #[test]
3817    fn large_string_single_column() {
3818        let raw_values: Vec<_> = (0..SMALL_SIZE).map(|i| i.to_string()).collect();
3819        let raw_strs = raw_values.iter().map(|s| s.as_str());
3820
3821        required_and_optional::<LargeStringArray, _>(raw_strs);
3822    }
3823
3824    #[test]
3825    fn string_view_single_column() {
3826        let raw_values: Vec<_> = (0..SMALL_SIZE).map(|i| i.to_string()).collect();
3827        let raw_strs = raw_values.iter().map(|s| s.as_str());
3828
3829        required_and_optional::<StringViewArray, _>(raw_strs);
3830    }
3831
3832    #[test]
3833    fn null_list_single_column() {
3834        let null_field = Field::new_list_field(DataType::Null, true);
3835        let list_field = Field::new("emptylist", DataType::List(Arc::new(null_field)), true);
3836
3837        let schema = Schema::new(vec![list_field]);
3838
3839        // Build [[], null, [null, null]]
3840        let a_values = NullArray::new(2);
3841        let a_value_offsets = arrow::buffer::Buffer::from([0, 0, 0, 2].to_byte_slice());
3842        let a_list_data = ArrayData::builder(DataType::List(Arc::new(Field::new_list_field(
3843            DataType::Null,
3844            true,
3845        ))))
3846        .len(3)
3847        .add_buffer(a_value_offsets)
3848        .null_bit_buffer(Some(Buffer::from([0b00000101])))
3849        .add_child_data(a_values.into_data())
3850        .build()
3851        .unwrap();
3852
3853        let a = ListArray::from(a_list_data);
3854
3855        assert!(a.is_valid(0));
3856        assert!(!a.is_valid(1));
3857        assert!(a.is_valid(2));
3858
3859        assert_eq!(a.value(0).len(), 0);
3860        assert_eq!(a.value(2).len(), 2);
3861        assert_eq!(a.value(2).logical_nulls().unwrap().null_count(), 2);
3862
3863        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a)]).unwrap();
3864        roundtrip(batch, None);
3865    }
3866
3867    #[test]
3868    fn list_single_column() {
3869        let a_values = Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
3870        let a_value_offsets = arrow::buffer::Buffer::from([0, 1, 3, 3, 6, 10].to_byte_slice());
3871        let a_list_data = ArrayData::builder(DataType::List(Arc::new(Field::new_list_field(
3872            DataType::Int32,
3873            false,
3874        ))))
3875        .len(5)
3876        .add_buffer(a_value_offsets)
3877        .null_bit_buffer(Some(Buffer::from([0b00011011])))
3878        .add_child_data(a_values.into_data())
3879        .build()
3880        .unwrap();
3881
3882        assert_eq!(a_list_data.null_count(), 1);
3883
3884        let a = ListArray::from(a_list_data);
3885        let values = Arc::new(a);
3886
3887        RoundTripTest::new(values).run();
3888    }
3889
3890    #[test]
3891    fn large_list_single_column() {
3892        let a_values = Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
3893        let a_value_offsets = arrow::buffer::Buffer::from([0i64, 1, 3, 3, 6, 10].to_byte_slice());
3894        let a_list_data = ArrayData::builder(DataType::LargeList(Arc::new(Field::new(
3895            "large_item",
3896            DataType::Int32,
3897            true,
3898        ))))
3899        .len(5)
3900        .add_buffer(a_value_offsets)
3901        .add_child_data(a_values.into_data())
3902        .null_bit_buffer(Some(Buffer::from([0b00011011])))
3903        .build()
3904        .unwrap();
3905
3906        // I think this setup is incorrect because this should pass
3907        assert_eq!(a_list_data.null_count(), 1);
3908
3909        let a = LargeListArray::from(a_list_data);
3910        let values = Arc::new(a);
3911
3912        RoundTripTest::new(values).run();
3913    }
3914
3915    #[test]
3916    fn list_nested_nulls() {
3917        use arrow::datatypes::Int32Type;
3918        let data = vec![
3919            Some(vec![Some(1)]),
3920            Some(vec![Some(2), Some(3)]),
3921            None,
3922            Some(vec![Some(4), Some(5), None]),
3923            Some(vec![None]),
3924            Some(vec![Some(6), Some(7)]),
3925        ];
3926
3927        let list = ListArray::from_iter_primitive::<Int32Type, _, _>(data.clone());
3928        RoundTripTest::new(Arc::new(list)).run();
3929
3930        let list = LargeListArray::from_iter_primitive::<Int32Type, _, _>(data);
3931        RoundTripTest::new(Arc::new(list)).run();
3932    }
3933
3934    #[test]
3935    fn list_utf8_view_selective_padding_roundtrip() {
3936        let item = Arc::new(Field::new_list_field(DataType::Utf8View, true));
3937        let mut builder = ListBuilder::new(StringViewBuilder::new()).with_field(item);
3938        builder.values().append_value("a");
3939        builder.values().append_null();
3940        builder.append(true);
3941        // The null parent list covers selective padding dropping values below
3942        // the list definition level while preserving the preceding item null.
3943        builder.append(false);
3944        // The long string covers the non-inlined Utf8View buffer path.
3945        builder.values().append_value("large payload over 12 bytes");
3946        builder.append(true);
3947
3948        RoundTripTest::new(Arc::new(builder.finish())).run();
3949    }
3950
3951    #[test]
3952    fn struct_single_column() {
3953        let a_values = Int32Array::from(vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
3954        let struct_field_a = Arc::new(Field::new("f", DataType::Int32, false));
3955        let s = StructArray::from(vec![(struct_field_a, Arc::new(a_values) as ArrayRef)]);
3956
3957        let values = Arc::new(s);
3958        RoundTripTest::new(values).with_nullable(false).run();
3959    }
3960
3961    #[test]
3962    fn list_and_map_coerced_names() {
3963        // Create map and list with non-Parquet naming
3964        let list_field =
3965            Field::new_list("my_list", Field::new("item", DataType::Int32, false), false);
3966        let map_field = Field::new_map(
3967            "my_map",
3968            "my_entries",
3969            Field::new("my_keys", DataType::Int32, false),
3970            Field::new("my_values", DataType::Int32, true),
3971            false,
3972            true,
3973        );
3974
3975        let list_array = create_random_array(&list_field, 100, 0.0, 0.0).unwrap();
3976        let map_array = create_random_array(&map_field, 100, 0.0, 0.0).unwrap();
3977
3978        let arrow_schema = Arc::new(Schema::new(vec![list_field, map_field]));
3979
3980        // Write data to Parquet but coerce names to match spec
3981        let props = Some(WriterProperties::builder().set_coerce_types(true).build());
3982        let file = tempfile::tempfile().unwrap();
3983        let mut writer =
3984            ArrowWriter::try_new(file.try_clone().unwrap(), arrow_schema.clone(), props).unwrap();
3985
3986        let batch = RecordBatch::try_new(arrow_schema, vec![list_array, map_array]).unwrap();
3987        writer.write(&batch).unwrap();
3988        let file_metadata = writer.close().unwrap();
3989
3990        let schema = file_metadata.file_metadata().schema();
3991        // Coerced name of "item" should be "element"
3992        let list_field = &schema.get_fields()[0].get_fields()[0];
3993        assert_eq!(list_field.get_fields()[0].name(), "element");
3994
3995        let map_field = &schema.get_fields()[1].get_fields()[0];
3996        // Coerced name of "entries" should be "key_value"
3997        assert_eq!(map_field.name(), "key_value");
3998        // Coerced name of "my_keys" should be "key"
3999        assert_eq!(map_field.get_fields()[0].name(), "key");
4000        // Coerced name of "my_values" should be "value"
4001        assert_eq!(map_field.get_fields()[1].name(), "value");
4002
4003        // Double check schema after reading from the file
4004        let reader = SerializedFileReader::new(file).unwrap();
4005        let file_schema = reader.metadata().file_metadata().schema();
4006        let fields = file_schema.get_fields();
4007        let list_field = &fields[0].get_fields()[0];
4008        assert_eq!(list_field.get_fields()[0].name(), "element");
4009        let map_field = &fields[1].get_fields()[0];
4010        assert_eq!(map_field.name(), "key_value");
4011        assert_eq!(map_field.get_fields()[0].name(), "key");
4012        assert_eq!(map_field.get_fields()[1].name(), "value");
4013    }
4014
4015    #[test]
4016    fn fallback_flush_data_page() {
4017        //tests if the Fallback::flush_data_page clears all buffers correctly
4018        let raw_values: Vec<_> = (0..MEDIUM_SIZE).map(|i| i.to_string()).collect();
4019        let values = Arc::new(StringArray::from(raw_values));
4020        let encodings = vec![
4021            Encoding::DELTA_BYTE_ARRAY,
4022            Encoding::DELTA_LENGTH_BYTE_ARRAY,
4023        ];
4024        let data_type = values.data_type().clone();
4025        let schema = Arc::new(Schema::new(vec![Field::new("col", data_type, false)]));
4026        let expected_batch = RecordBatch::try_new(schema, vec![values]).unwrap();
4027
4028        let row_group_sizes = [1024, SMALL_SIZE, SMALL_SIZE / 2, SMALL_SIZE / 2 + 1, 10];
4029        let data_page_size_limit: usize = 32;
4030        let write_batch_size: usize = 16;
4031
4032        for encoding in &encodings {
4033            for row_group_size in row_group_sizes {
4034                let props = WriterProperties::builder()
4035                    .set_writer_version(WriterVersion::PARQUET_2_0)
4036                    .set_max_row_group_row_count(Some(row_group_size))
4037                    .set_dictionary_enabled(false)
4038                    .set_encoding(*encoding)
4039                    .set_data_page_size_limit(data_page_size_limit)
4040                    .set_write_batch_size(write_batch_size)
4041                    .build();
4042
4043                roundtrip_opts_with_array_validation(&expected_batch, props, |a, b| {
4044                    let string_array_a = StringArray::from(a.clone());
4045                    let string_array_b = StringArray::from(b.clone());
4046                    let vec_a: Vec<&str> = string_array_a.iter().map(|v| v.unwrap()).collect();
4047                    let vec_b: Vec<&str> = string_array_b.iter().map(|v| v.unwrap()).collect();
4048                    assert_eq!(
4049                        vec_a, vec_b,
4050                        "failed for encoder: {encoding:?} and row_group_size: {row_group_size:?}"
4051                    );
4052                });
4053            }
4054        }
4055    }
4056
4057    #[test]
4058    fn arrow_writer_string_dictionary() {
4059        // define schema
4060        #[allow(deprecated)]
4061        let schema = Arc::new(Schema::new(vec![Field::new_dict(
4062            "dictionary",
4063            DataType::Dictionary(Box::new(DataType::Int32), Box::new(DataType::Utf8)),
4064            true,
4065            42,
4066            true,
4067        )]));
4068
4069        // create some data
4070        let d: Int32DictionaryArray = [Some("alpha"), None, Some("beta"), Some("alpha")]
4071            .iter()
4072            .copied()
4073            .collect();
4074
4075        // build a record batch
4076        RoundTripTest::new(Arc::new(d)).with_schema(schema).run();
4077    }
4078
4079    #[test]
4080    fn arrow_writer_test_type_compatibility() {
4081        fn ensure_compatible_write<T1, T2>(array1: T1, array2: T2, expected_result: T1)
4082        where
4083            T1: Array + 'static,
4084            T2: Array + 'static,
4085        {
4086            let schema1 = Arc::new(Schema::new(vec![Field::new(
4087                "a",
4088                array1.data_type().clone(),
4089                false,
4090            )]));
4091
4092            let file = tempfile().unwrap();
4093            let mut writer =
4094                ArrowWriter::try_new(file.try_clone().unwrap(), schema1.clone(), None).unwrap();
4095
4096            let rb1 = RecordBatch::try_new(schema1.clone(), vec![Arc::new(array1)]).unwrap();
4097            writer.write(&rb1).unwrap();
4098
4099            let schema2 = Arc::new(Schema::new(vec![Field::new(
4100                "a",
4101                array2.data_type().clone(),
4102                false,
4103            )]));
4104            let rb2 = RecordBatch::try_new(schema2, vec![Arc::new(array2)]).unwrap();
4105            writer.write(&rb2).unwrap();
4106
4107            writer.close().unwrap();
4108
4109            let mut record_batch_reader =
4110                ParquetRecordBatchReader::try_new(file.try_clone().unwrap(), 1024).unwrap();
4111            let actual_batch = record_batch_reader.next().unwrap().unwrap();
4112
4113            let expected_batch =
4114                RecordBatch::try_new(schema1, vec![Arc::new(expected_result)]).unwrap();
4115            assert_eq!(actual_batch, expected_batch);
4116        }
4117
4118        // check compatibility between native and dictionaries
4119
4120        ensure_compatible_write(
4121            DictionaryArray::new(
4122                UInt8Array::from_iter_values(vec![0]),
4123                Arc::new(StringArray::from_iter_values(vec!["parquet"])),
4124            ),
4125            StringArray::from_iter_values(vec!["barquet"]),
4126            DictionaryArray::new(
4127                UInt8Array::from_iter_values(vec![0, 1]),
4128                Arc::new(StringArray::from_iter_values(vec!["parquet", "barquet"])),
4129            ),
4130        );
4131
4132        ensure_compatible_write(
4133            StringArray::from_iter_values(vec!["parquet"]),
4134            DictionaryArray::new(
4135                UInt8Array::from_iter_values(vec![0]),
4136                Arc::new(StringArray::from_iter_values(vec!["barquet"])),
4137            ),
4138            StringArray::from_iter_values(vec!["parquet", "barquet"]),
4139        );
4140
4141        // check compatibility between dictionaries with different key types
4142
4143        ensure_compatible_write(
4144            DictionaryArray::new(
4145                UInt8Array::from_iter_values(vec![0]),
4146                Arc::new(StringArray::from_iter_values(vec!["parquet"])),
4147            ),
4148            DictionaryArray::new(
4149                UInt16Array::from_iter_values(vec![0]),
4150                Arc::new(StringArray::from_iter_values(vec!["barquet"])),
4151            ),
4152            DictionaryArray::new(
4153                UInt8Array::from_iter_values(vec![0, 1]),
4154                Arc::new(StringArray::from_iter_values(vec!["parquet", "barquet"])),
4155            ),
4156        );
4157
4158        // check compatibility between dictionaries with different value types
4159        ensure_compatible_write(
4160            DictionaryArray::new(
4161                UInt8Array::from_iter_values(vec![0]),
4162                Arc::new(StringArray::from_iter_values(vec!["parquet"])),
4163            ),
4164            DictionaryArray::new(
4165                UInt8Array::from_iter_values(vec![0]),
4166                Arc::new(LargeStringArray::from_iter_values(vec!["barquet"])),
4167            ),
4168            DictionaryArray::new(
4169                UInt8Array::from_iter_values(vec![0, 1]),
4170                Arc::new(StringArray::from_iter_values(vec!["parquet", "barquet"])),
4171            ),
4172        );
4173
4174        // check compatibility between a dictionary and a native array with a different type
4175        ensure_compatible_write(
4176            DictionaryArray::new(
4177                UInt8Array::from_iter_values(vec![0]),
4178                Arc::new(StringArray::from_iter_values(vec!["parquet"])),
4179            ),
4180            LargeStringArray::from_iter_values(vec!["barquet"]),
4181            DictionaryArray::new(
4182                UInt8Array::from_iter_values(vec![0, 1]),
4183                Arc::new(StringArray::from_iter_values(vec!["parquet", "barquet"])),
4184            ),
4185        );
4186
4187        // check compatibility for string types
4188
4189        ensure_compatible_write(
4190            StringArray::from_iter_values(vec!["parquet"]),
4191            LargeStringArray::from_iter_values(vec!["barquet"]),
4192            StringArray::from_iter_values(vec!["parquet", "barquet"]),
4193        );
4194
4195        ensure_compatible_write(
4196            LargeStringArray::from_iter_values(vec!["parquet"]),
4197            StringArray::from_iter_values(vec!["barquet"]),
4198            LargeStringArray::from_iter_values(vec!["parquet", "barquet"]),
4199        );
4200
4201        ensure_compatible_write(
4202            StringArray::from_iter_values(vec!["parquet"]),
4203            StringViewArray::from_iter_values(vec!["barquet"]),
4204            StringArray::from_iter_values(vec!["parquet", "barquet"]),
4205        );
4206
4207        ensure_compatible_write(
4208            StringViewArray::from_iter_values(vec!["parquet"]),
4209            StringArray::from_iter_values(vec!["barquet"]),
4210            StringViewArray::from_iter_values(vec!["parquet", "barquet"]),
4211        );
4212
4213        ensure_compatible_write(
4214            LargeStringArray::from_iter_values(vec!["parquet"]),
4215            StringViewArray::from_iter_values(vec!["barquet"]),
4216            LargeStringArray::from_iter_values(vec!["parquet", "barquet"]),
4217        );
4218
4219        ensure_compatible_write(
4220            StringViewArray::from_iter_values(vec!["parquet"]),
4221            LargeStringArray::from_iter_values(vec!["barquet"]),
4222            StringViewArray::from_iter_values(vec!["parquet", "barquet"]),
4223        );
4224
4225        // check compatibility for binary types
4226
4227        ensure_compatible_write(
4228            BinaryArray::from_iter_values(vec![b"parquet"]),
4229            LargeBinaryArray::from_iter_values(vec![b"barquet"]),
4230            BinaryArray::from_iter_values(vec![b"parquet", b"barquet"]),
4231        );
4232
4233        ensure_compatible_write(
4234            LargeBinaryArray::from_iter_values(vec![b"parquet"]),
4235            BinaryArray::from_iter_values(vec![b"barquet"]),
4236            LargeBinaryArray::from_iter_values(vec![b"parquet", b"barquet"]),
4237        );
4238
4239        ensure_compatible_write(
4240            BinaryArray::from_iter_values(vec![b"parquet"]),
4241            BinaryViewArray::from_iter_values(vec![b"barquet"]),
4242            BinaryArray::from_iter_values(vec![b"parquet", b"barquet"]),
4243        );
4244
4245        ensure_compatible_write(
4246            BinaryViewArray::from_iter_values(vec![b"parquet"]),
4247            BinaryArray::from_iter_values(vec![b"barquet"]),
4248            BinaryViewArray::from_iter_values(vec![b"parquet", b"barquet"]),
4249        );
4250
4251        ensure_compatible_write(
4252            BinaryViewArray::from_iter_values(vec![b"parquet"]),
4253            LargeBinaryArray::from_iter_values(vec![b"barquet"]),
4254            BinaryViewArray::from_iter_values(vec![b"parquet", b"barquet"]),
4255        );
4256
4257        ensure_compatible_write(
4258            LargeBinaryArray::from_iter_values(vec![b"parquet"]),
4259            BinaryViewArray::from_iter_values(vec![b"barquet"]),
4260            LargeBinaryArray::from_iter_values(vec![b"parquet", b"barquet"]),
4261        );
4262
4263        // check compatibility for list types
4264
4265        let list_field_metadata = HashMap::from_iter(vec![(
4266            PARQUET_FIELD_ID_META_KEY.to_string(),
4267            "1".to_string(),
4268        )]);
4269        let list_field = Field::new_list_field(DataType::Int32, false);
4270
4271        let values1 = Arc::new(Int32Array::from(vec![0, 1, 2, 3, 4]));
4272        let offsets1 = OffsetBuffer::new(vec![0, 2, 5].into());
4273
4274        let values2 = Arc::new(Int32Array::from(vec![5, 6, 7, 8, 9]));
4275        let offsets2 = OffsetBuffer::new(vec![0, 3, 5].into());
4276
4277        let values_expected = Arc::new(Int32Array::from(vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9]));
4278        let offsets_expected = OffsetBuffer::new(vec![0, 2, 5, 8, 10].into());
4279
4280        ensure_compatible_write(
4281            // when the initial schema has the metadata ...
4282            ListArray::try_new(
4283                Arc::new(
4284                    list_field
4285                        .clone()
4286                        .with_metadata(list_field_metadata.clone()),
4287                ),
4288                offsets1,
4289                values1,
4290                None,
4291            )
4292            .unwrap(),
4293            // ... and some intermediate schema doesn't have the metadata
4294            ListArray::try_new(Arc::new(list_field.clone()), offsets2, values2, None).unwrap(),
4295            // ... the write will still go through, and the resulting schema will inherit the initial metadata
4296            ListArray::try_new(
4297                Arc::new(
4298                    list_field
4299                        .clone()
4300                        .with_metadata(list_field_metadata.clone()),
4301                ),
4302                offsets_expected,
4303                values_expected,
4304                None,
4305            )
4306            .unwrap(),
4307        );
4308    }
4309
4310    #[test]
4311    fn arrow_writer_primitive_dictionary() {
4312        // define schema
4313        #[allow(deprecated)]
4314        let schema = Arc::new(Schema::new(vec![Field::new_dict(
4315            "dictionary",
4316            DataType::Dictionary(Box::new(DataType::UInt8), Box::new(DataType::UInt32)),
4317            true,
4318            42,
4319            true,
4320        )]));
4321
4322        // create some data
4323        let mut builder = PrimitiveDictionaryBuilder::<UInt8Type, UInt32Type>::new();
4324        builder.append(12345678).unwrap();
4325        builder.append_null();
4326        builder.append(22345678).unwrap();
4327        builder.append(12345678).unwrap();
4328        let d = builder.finish();
4329
4330        RoundTripTest::new(Arc::new(d)).with_schema(schema).run();
4331    }
4332
4333    #[test]
4334    fn arrow_writer_decimal32_dictionary() {
4335        let integers = vec![12345, 56789, 34567];
4336
4337        let keys = UInt8Array::from(vec![Some(0), None, Some(1), Some(2), Some(1)]);
4338
4339        let values = Decimal32Array::from(integers.clone())
4340            .with_precision_and_scale(5, 2)
4341            .unwrap();
4342
4343        let array = DictionaryArray::new(keys, Arc::new(values));
4344        RoundTripTest::new(Arc::new(array.clone())).run();
4345
4346        let values = Decimal32Array::from(integers)
4347            .with_precision_and_scale(9, 2)
4348            .unwrap();
4349
4350        let array = array.with_values(Arc::new(values));
4351        RoundTripTest::new(Arc::new(array)).run();
4352    }
4353
4354    #[test]
4355    fn arrow_writer_decimal64_dictionary() {
4356        let integers = vec![12345, 56789, 34567];
4357
4358        let keys = UInt8Array::from(vec![Some(0), None, Some(1), Some(2), Some(1)]);
4359
4360        let values = Decimal64Array::from(integers.clone())
4361            .with_precision_and_scale(5, 2)
4362            .unwrap();
4363
4364        let array = DictionaryArray::new(keys, Arc::new(values));
4365        RoundTripTest::new(Arc::new(array.clone())).run();
4366
4367        let values = Decimal64Array::from(integers)
4368            .with_precision_and_scale(12, 2)
4369            .unwrap();
4370
4371        let array = array.with_values(Arc::new(values));
4372        RoundTripTest::new(Arc::new(array)).run();
4373    }
4374
4375    #[test]
4376    fn arrow_writer_decimal128_dictionary() {
4377        let integers = vec![12345, 56789, 34567];
4378
4379        let keys = UInt8Array::from(vec![Some(0), None, Some(1), Some(2), Some(1)]);
4380
4381        let values = Decimal128Array::from(integers.clone())
4382            .with_precision_and_scale(5, 2)
4383            .unwrap();
4384
4385        let array = DictionaryArray::new(keys, Arc::new(values));
4386        RoundTripTest::new(Arc::new(array.clone())).run();
4387
4388        let values = Decimal128Array::from(integers)
4389            .with_precision_and_scale(12, 2)
4390            .unwrap();
4391
4392        let array = array.with_values(Arc::new(values));
4393        RoundTripTest::new(Arc::new(array)).run();
4394    }
4395
4396    #[test]
4397    fn arrow_writer_decimal256_dictionary() {
4398        let integers = vec![
4399            i256::from_i128(12345),
4400            i256::from_i128(56789),
4401            i256::from_i128(34567),
4402        ];
4403
4404        let keys = UInt8Array::from(vec![Some(0), None, Some(1), Some(2), Some(1)]);
4405
4406        let values = Decimal256Array::from(integers.clone())
4407            .with_precision_and_scale(5, 2)
4408            .unwrap();
4409
4410        let array = DictionaryArray::new(keys, Arc::new(values));
4411        RoundTripTest::new(Arc::new(array.clone())).run();
4412
4413        let values = Decimal256Array::from(integers)
4414            .with_precision_and_scale(12, 2)
4415            .unwrap();
4416
4417        let array = array.with_values(Arc::new(values));
4418        RoundTripTest::new(Arc::new(array)).run();
4419    }
4420
4421    #[test]
4422    fn arrow_writer_string_dictionary_unsigned_index() {
4423        // define schema
4424        #[allow(deprecated)]
4425        let schema = Arc::new(Schema::new(vec![Field::new_dict(
4426            "dictionary",
4427            DataType::Dictionary(Box::new(DataType::UInt8), Box::new(DataType::Utf8)),
4428            true,
4429            42,
4430            true,
4431        )]));
4432
4433        // create some data
4434        let d: UInt8DictionaryArray = [Some("alpha"), None, Some("beta"), Some("alpha")]
4435            .iter()
4436            .copied()
4437            .collect();
4438
4439        RoundTripTest::new(Arc::new(d)).with_schema(schema).run();
4440    }
4441
4442    #[test]
4443    fn u32_min_max() {
4444        // check values roundtrip through parquet
4445        let src = [
4446            u32::MIN,
4447            1,
4448            (i32::MAX as u32) - 1,
4449            i32::MAX as u32,
4450            (i32::MAX as u32) + 1,
4451            u32::MAX - 1,
4452            u32::MAX,
4453        ];
4454        let values = Arc::new(UInt32Array::from_iter_values(src.iter().copied()));
4455        let files = RoundTripTest::new(values).with_nullable(false).run();
4456
4457        for file in files {
4458            // check statistics are valid
4459            let reader = SerializedFileReader::new(file).unwrap();
4460            let metadata = reader.metadata();
4461
4462            let mut row_offset = 0;
4463            for row_group in metadata.row_groups() {
4464                assert_eq!(row_group.num_columns(), 1);
4465                let column = row_group.column(0);
4466
4467                let num_values = column.num_values() as usize;
4468                let src_slice = &src[row_offset..row_offset + num_values];
4469                row_offset += column.num_values() as usize;
4470
4471                let stats = column.statistics().unwrap();
4472                if let Statistics::Int32(stats) = stats {
4473                    assert_eq!(
4474                        *stats.min_opt().unwrap() as u32,
4475                        *src_slice.iter().min().unwrap()
4476                    );
4477                    assert_eq!(
4478                        *stats.max_opt().unwrap() as u32,
4479                        *src_slice.iter().max().unwrap()
4480                    );
4481                } else {
4482                    panic!("Statistics::Int32 missing")
4483                }
4484            }
4485        }
4486    }
4487
4488    #[test]
4489    fn u64_min_max() {
4490        // check values roundtrip through parquet
4491        let src = [
4492            u64::MIN,
4493            1,
4494            (i64::MAX as u64) - 1,
4495            i64::MAX as u64,
4496            (i64::MAX as u64) + 1,
4497            u64::MAX - 1,
4498            u64::MAX,
4499        ];
4500        let values = Arc::new(UInt64Array::from_iter_values(src.iter().copied()));
4501        let files = RoundTripTest::new(values).with_nullable(false).run();
4502
4503        for file in files {
4504            // check statistics are valid
4505            let reader = SerializedFileReader::new(file).unwrap();
4506            let metadata = reader.metadata();
4507
4508            let mut row_offset = 0;
4509            for row_group in metadata.row_groups() {
4510                assert_eq!(row_group.num_columns(), 1);
4511                let column = row_group.column(0);
4512
4513                let num_values = column.num_values() as usize;
4514                let src_slice = &src[row_offset..row_offset + num_values];
4515                row_offset += column.num_values() as usize;
4516
4517                let stats = column.statistics().unwrap();
4518                if let Statistics::Int64(stats) = stats {
4519                    assert_eq!(
4520                        *stats.min_opt().unwrap() as u64,
4521                        *src_slice.iter().min().unwrap()
4522                    );
4523                    assert_eq!(
4524                        *stats.max_opt().unwrap() as u64,
4525                        *src_slice.iter().max().unwrap()
4526                    );
4527                } else {
4528                    panic!("Statistics::Int64 missing")
4529                }
4530            }
4531        }
4532    }
4533
4534    #[test]
4535    fn statistics_null_counts_only_nulls() {
4536        // check that null-count statistics for "only NULL"-columns are correct
4537        let values = Arc::new(UInt64Array::from(vec![None, None]));
4538        let files = RoundTripTest::new(values).run();
4539
4540        for file in files {
4541            // check statistics are valid
4542            let reader = SerializedFileReader::new(file).unwrap();
4543            let metadata = reader.metadata();
4544            assert_eq!(metadata.num_row_groups(), 1);
4545            let row_group = metadata.row_group(0);
4546            assert_eq!(row_group.num_columns(), 1);
4547            let column = row_group.column(0);
4548            let stats = column.statistics().unwrap();
4549            assert_eq!(stats.null_count_opt(), Some(2));
4550        }
4551    }
4552
4553    #[test]
4554    fn test_list_of_struct_roundtrip() {
4555        // define schema
4556        let int_field = Field::new("a", DataType::Int32, true);
4557        let int_field2 = Field::new("b", DataType::Int32, true);
4558
4559        let int_builder = Int32Builder::with_capacity(10);
4560        let int_builder2 = Int32Builder::with_capacity(10);
4561
4562        let struct_builder = StructBuilder::new(
4563            vec![int_field, int_field2],
4564            vec![Box::new(int_builder), Box::new(int_builder2)],
4565        );
4566        let mut list_builder = ListBuilder::new(struct_builder);
4567
4568        // Construct the following array
4569        // [{a: 1, b: 2}], [], null, [null, null], [{a: null, b: 3}], [{a: 2, b: null}]
4570
4571        // [{a: 1, b: 2}]
4572        let values = list_builder.values();
4573        values
4574            .field_builder::<Int32Builder>(0)
4575            .unwrap()
4576            .append_value(1);
4577        values
4578            .field_builder::<Int32Builder>(1)
4579            .unwrap()
4580            .append_value(2);
4581        values.append(true);
4582        list_builder.append(true);
4583
4584        // []
4585        list_builder.append(true);
4586
4587        // null
4588        list_builder.append(false);
4589
4590        // [null, null]
4591        let values = list_builder.values();
4592        values
4593            .field_builder::<Int32Builder>(0)
4594            .unwrap()
4595            .append_null();
4596        values
4597            .field_builder::<Int32Builder>(1)
4598            .unwrap()
4599            .append_null();
4600        values.append(false);
4601        values
4602            .field_builder::<Int32Builder>(0)
4603            .unwrap()
4604            .append_null();
4605        values
4606            .field_builder::<Int32Builder>(1)
4607            .unwrap()
4608            .append_null();
4609        values.append(false);
4610        list_builder.append(true);
4611
4612        // [{a: null, b: 3}]
4613        let values = list_builder.values();
4614        values
4615            .field_builder::<Int32Builder>(0)
4616            .unwrap()
4617            .append_null();
4618        values
4619            .field_builder::<Int32Builder>(1)
4620            .unwrap()
4621            .append_value(3);
4622        values.append(true);
4623        list_builder.append(true);
4624
4625        // [{a: 2, b: null}]
4626        let values = list_builder.values();
4627        values
4628            .field_builder::<Int32Builder>(0)
4629            .unwrap()
4630            .append_value(2);
4631        values
4632            .field_builder::<Int32Builder>(1)
4633            .unwrap()
4634            .append_null();
4635        values.append(true);
4636        list_builder.append(true);
4637
4638        let array = Arc::new(list_builder.finish());
4639
4640        RoundTripTest::new(array).run();
4641    }
4642
4643    fn row_group_sizes(metadata: &ParquetMetaData) -> Vec<i64> {
4644        metadata.row_groups().iter().map(|x| x.num_rows()).collect()
4645    }
4646
4647    #[test]
4648    fn test_aggregates_records() {
4649        let arrays = [
4650            Int32Array::from((0..100).collect::<Vec<_>>()),
4651            Int32Array::from((0..50).collect::<Vec<_>>()),
4652            Int32Array::from((200..500).collect::<Vec<_>>()),
4653        ];
4654
4655        let schema = Arc::new(Schema::new(vec![Field::new(
4656            "int",
4657            ArrowDataType::Int32,
4658            false,
4659        )]));
4660
4661        let file = tempfile::tempfile().unwrap();
4662
4663        let props = WriterProperties::builder()
4664            .set_max_row_group_row_count(Some(200))
4665            .build();
4666
4667        let mut writer =
4668            ArrowWriter::try_new(file.try_clone().unwrap(), schema.clone(), Some(props)).unwrap();
4669
4670        for array in arrays {
4671            let batch = RecordBatch::try_new(schema.clone(), vec![Arc::new(array)]).unwrap();
4672            writer.write(&batch).unwrap();
4673        }
4674
4675        writer.close().unwrap();
4676
4677        let builder = ParquetRecordBatchReaderBuilder::try_new(file).unwrap();
4678        assert_eq!(&row_group_sizes(builder.metadata()), &[200, 200, 50]);
4679
4680        let batches = builder
4681            .with_batch_size(100)
4682            .build()
4683            .unwrap()
4684            .collect::<ArrowResult<Vec<_>>>()
4685            .unwrap();
4686
4687        assert_eq!(batches.len(), 5);
4688        assert!(batches.iter().all(|x| x.num_columns() == 1));
4689
4690        let batch_sizes: Vec<_> = batches.iter().map(|x| x.num_rows()).collect();
4691
4692        assert_eq!(&batch_sizes, &[100, 100, 100, 100, 50]);
4693
4694        let values: Vec<_> = batches
4695            .iter()
4696            .flat_map(|x| {
4697                x.column(0)
4698                    .as_any()
4699                    .downcast_ref::<Int32Array>()
4700                    .unwrap()
4701                    .values()
4702                    .iter()
4703                    .copied()
4704            })
4705            .collect();
4706
4707        let expected_values: Vec<_> = [0..100, 0..50, 200..500].into_iter().flatten().collect();
4708        assert_eq!(&values, &expected_values)
4709    }
4710
4711    #[test]
4712    fn complex_aggregate() {
4713        // Tests aggregating nested data
4714        let field_a = Arc::new(Field::new("leaf_a", DataType::Int32, false));
4715        let field_b = Arc::new(Field::new("leaf_b", DataType::Int32, true));
4716        let struct_a = Arc::new(Field::new(
4717            "struct_a",
4718            DataType::Struct(vec![field_a.clone(), field_b.clone()].into()),
4719            true,
4720        ));
4721
4722        let list_a = Arc::new(Field::new("list", DataType::List(struct_a), true));
4723        let struct_b = Arc::new(Field::new(
4724            "struct_b",
4725            DataType::Struct(vec![list_a.clone()].into()),
4726            false,
4727        ));
4728
4729        let schema = Arc::new(Schema::new(vec![struct_b]));
4730
4731        // create nested data
4732        let field_a_array = Int32Array::from(vec![1, 2, 3, 4, 5, 6]);
4733        let field_b_array =
4734            Int32Array::from_iter(vec![Some(1), None, Some(2), None, None, Some(6)]);
4735
4736        let struct_a_array = StructArray::from(vec![
4737            (field_a.clone(), Arc::new(field_a_array) as ArrayRef),
4738            (field_b.clone(), Arc::new(field_b_array) as ArrayRef),
4739        ]);
4740
4741        let list_data = ArrayDataBuilder::new(list_a.data_type().clone())
4742            .len(5)
4743            .add_buffer(Buffer::from_iter(vec![
4744                0_i32, 1_i32, 1_i32, 3_i32, 3_i32, 5_i32,
4745            ]))
4746            .null_bit_buffer(Some(Buffer::from_iter(vec![
4747                true, false, true, false, true,
4748            ])))
4749            .child_data(vec![struct_a_array.into_data()])
4750            .build()
4751            .unwrap();
4752
4753        let list_a_array = Arc::new(ListArray::from(list_data)) as ArrayRef;
4754        let struct_b_array = StructArray::from(vec![(list_a.clone(), list_a_array)]);
4755
4756        let batch1 =
4757            RecordBatch::try_from_iter(vec![("struct_b", Arc::new(struct_b_array) as ArrayRef)])
4758                .unwrap();
4759
4760        let field_a_array = Int32Array::from(vec![6, 7, 8, 9, 10]);
4761        let field_b_array = Int32Array::from_iter(vec![None, None, None, Some(1), None]);
4762
4763        let struct_a_array = StructArray::from(vec![
4764            (field_a, Arc::new(field_a_array) as ArrayRef),
4765            (field_b, Arc::new(field_b_array) as ArrayRef),
4766        ]);
4767
4768        let list_data = ArrayDataBuilder::new(list_a.data_type().clone())
4769            .len(2)
4770            .add_buffer(Buffer::from_iter(vec![0_i32, 4_i32, 5_i32]))
4771            .child_data(vec![struct_a_array.into_data()])
4772            .build()
4773            .unwrap();
4774
4775        let list_a_array = Arc::new(ListArray::from(list_data)) as ArrayRef;
4776        let struct_b_array = StructArray::from(vec![(list_a, list_a_array)]);
4777
4778        let batch2 =
4779            RecordBatch::try_from_iter(vec![("struct_b", Arc::new(struct_b_array) as ArrayRef)])
4780                .unwrap();
4781
4782        let batches = &[batch1, batch2];
4783
4784        // Verify data is as expected
4785
4786        let expected = r"
4787            +-------------------------------------------------------------------------------------------------------+
4788            | struct_b                                                                                              |
4789            +-------------------------------------------------------------------------------------------------------+
4790            | {list: [{leaf_a: 1, leaf_b: 1}]}                                                                      |
4791            | {list: }                                                                                              |
4792            | {list: [{leaf_a: 2, leaf_b: }, {leaf_a: 3, leaf_b: 2}]}                                               |
4793            | {list: }                                                                                              |
4794            | {list: [{leaf_a: 4, leaf_b: }, {leaf_a: 5, leaf_b: }]}                                                |
4795            | {list: [{leaf_a: 6, leaf_b: }, {leaf_a: 7, leaf_b: }, {leaf_a: 8, leaf_b: }, {leaf_a: 9, leaf_b: 1}]} |
4796            | {list: [{leaf_a: 10, leaf_b: }]}                                                                      |
4797            +-------------------------------------------------------------------------------------------------------+
4798        ".trim().split('\n').map(|x| x.trim()).collect::<Vec<_>>().join("\n");
4799
4800        let actual = pretty_format_batches(batches).unwrap().to_string();
4801        assert_eq!(actual, expected);
4802
4803        // Write data
4804        let file = tempfile::tempfile().unwrap();
4805        let props = WriterProperties::builder()
4806            .set_max_row_group_row_count(Some(6))
4807            .build();
4808
4809        let mut writer =
4810            ArrowWriter::try_new(file.try_clone().unwrap(), schema, Some(props)).unwrap();
4811
4812        for batch in batches {
4813            writer.write(batch).unwrap();
4814        }
4815        writer.close().unwrap();
4816
4817        // Read Data
4818        // Should have written entire first batch and first row of second to the first row group
4819        // leaving a single row in the second row group
4820
4821        let builder = ParquetRecordBatchReaderBuilder::try_new(file).unwrap();
4822        assert_eq!(&row_group_sizes(builder.metadata()), &[6, 1]);
4823
4824        let batches = builder
4825            .with_batch_size(2)
4826            .build()
4827            .unwrap()
4828            .collect::<ArrowResult<Vec<_>>>()
4829            .unwrap();
4830
4831        assert_eq!(batches.len(), 4);
4832        let batch_counts: Vec<_> = batches.iter().map(|x| x.num_rows()).collect();
4833        assert_eq!(&batch_counts, &[2, 2, 2, 1]);
4834
4835        let actual = pretty_format_batches(&batches).unwrap().to_string();
4836        assert_eq!(actual, expected);
4837    }
4838
4839    #[test]
4840    fn test_arrow_writer_metadata() {
4841        let batch_schema = Schema::new(vec![Field::new("int32", DataType::Int32, false)]);
4842        let file_schema = batch_schema.clone().with_metadata([("foo", "bar")]);
4843
4844        let batch = RecordBatch::try_new(
4845            Arc::new(batch_schema),
4846            vec![Arc::new(Int32Array::from(vec![1, 2, 3, 4])) as _],
4847        )
4848        .unwrap();
4849
4850        let mut buf = Vec::with_capacity(1024);
4851        let mut writer = ArrowWriter::try_new(&mut buf, Arc::new(file_schema), None).unwrap();
4852        writer.write(&batch).unwrap();
4853        writer.close().unwrap();
4854    }
4855
4856    #[test]
4857    fn test_arrow_writer_nullable() {
4858        let batch_schema = Schema::new(vec![Field::new("int32", DataType::Int32, false)]);
4859        let file_schema = Schema::new(vec![Field::new("int32", DataType::Int32, true)]);
4860        let file_schema = Arc::new(file_schema);
4861
4862        let batch = RecordBatch::try_new(
4863            Arc::new(batch_schema),
4864            vec![Arc::new(Int32Array::from(vec![1, 2, 3, 4])) as _],
4865        )
4866        .unwrap();
4867
4868        let mut buf = Vec::with_capacity(1024);
4869        let mut writer = ArrowWriter::try_new(&mut buf, file_schema.clone(), None).unwrap();
4870        writer.write(&batch).unwrap();
4871        writer.close().unwrap();
4872
4873        let mut read = ParquetRecordBatchReader::try_new(Bytes::from(buf), 1024).unwrap();
4874        let back = read.next().unwrap().unwrap();
4875        assert_eq!(back.schema(), file_schema);
4876        assert_ne!(back.schema(), batch.schema());
4877        assert_eq!(back.column(0).as_ref(), batch.column(0).as_ref());
4878    }
4879
4880    #[test]
4881    fn in_progress_accounting() {
4882        // define schema
4883        let schema = Schema::new(vec![Field::new("a", DataType::Int32, false)]);
4884
4885        // create some data
4886        let a = Int32Array::from(vec![1, 2, 3, 4, 5]);
4887
4888        // build a record batch
4889        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(a)]).unwrap();
4890
4891        let mut writer = ArrowWriter::try_new(vec![], batch.schema(), None).unwrap();
4892
4893        // starts empty
4894        assert_eq!(writer.in_progress_size(), 0);
4895        assert_eq!(writer.in_progress_rows(), 0);
4896        assert_eq!(writer.memory_size(), 0);
4897        assert_eq!(writer.bytes_written(), 4); // Initial header
4898        writer.write(&batch).unwrap();
4899
4900        // updated on write
4901        let initial_size = writer.in_progress_size();
4902        assert!(initial_size > 0);
4903        assert_eq!(writer.in_progress_rows(), 5);
4904        let initial_memory = writer.memory_size();
4905        assert!(initial_memory > 0);
4906        // memory estimate is larger than estimated encoded size
4907        assert!(
4908            initial_size <= initial_memory,
4909            "{initial_size} <= {initial_memory}"
4910        );
4911
4912        // updated on second write
4913        writer.write(&batch).unwrap();
4914        assert!(writer.in_progress_size() > initial_size);
4915        assert_eq!(writer.in_progress_rows(), 10);
4916        assert!(writer.memory_size() > initial_memory);
4917        assert!(
4918            writer.in_progress_size() <= writer.memory_size(),
4919            "in_progress_size {} <= memory_size {}",
4920            writer.in_progress_size(),
4921            writer.memory_size()
4922        );
4923
4924        // in progress tracking is cleared, but the overall data written is updated
4925        let pre_flush_bytes_written = writer.bytes_written();
4926        writer.flush().unwrap();
4927        assert_eq!(writer.in_progress_size(), 0);
4928        assert_eq!(writer.memory_size(), 0);
4929        assert!(writer.bytes_written() > pre_flush_bytes_written);
4930
4931        writer.close().unwrap();
4932    }
4933
4934    #[test]
4935    fn test_writer_all_null() {
4936        let a = Int32Array::from(vec![1, 2, 3, 4, 5]);
4937        let b = Int32Array::new(vec![0; 5].into(), Some(NullBuffer::new_null(5)));
4938        let batch = RecordBatch::try_from_iter(vec![
4939            ("a", Arc::new(a) as ArrayRef),
4940            ("b", Arc::new(b) as ArrayRef),
4941        ])
4942        .unwrap();
4943
4944        let mut buf = Vec::with_capacity(1024);
4945        let mut writer = ArrowWriter::try_new(&mut buf, batch.schema(), None).unwrap();
4946        writer.write(&batch).unwrap();
4947        writer.close().unwrap();
4948
4949        let bytes = Bytes::from(buf);
4950        let options = ReadOptionsBuilder::new().with_page_index().build();
4951        let reader = SerializedFileReader::new_with_options(bytes, options).unwrap();
4952        let index = reader.metadata().offset_index().unwrap();
4953
4954        assert_eq!(index.len(), 1);
4955        assert_eq!(index[0].len(), 2); // 2 columns
4956        assert_eq!(index[0][0].page_locations().len(), 1); // 1 page
4957        assert_eq!(index[0][1].page_locations().len(), 1); // 1 page
4958    }
4959
4960    #[test]
4961    fn test_disabled_statistics_with_page() {
4962        let file_schema = Schema::new(vec![
4963            Field::new("a", DataType::Utf8, true),
4964            Field::new("b", DataType::Utf8, true),
4965        ]);
4966        let file_schema = Arc::new(file_schema);
4967
4968        let batch = RecordBatch::try_new(
4969            file_schema.clone(),
4970            vec![
4971                Arc::new(StringArray::from(vec!["a", "b", "c", "d"])) as _,
4972                Arc::new(StringArray::from(vec!["w", "x", "y", "z"])) as _,
4973            ],
4974        )
4975        .unwrap();
4976
4977        let props = WriterProperties::builder()
4978            .set_statistics_enabled(EnabledStatistics::None)
4979            .set_column_statistics_enabled("a".into(), EnabledStatistics::Page)
4980            .build();
4981
4982        let mut buf = Vec::with_capacity(1024);
4983        let mut writer = ArrowWriter::try_new(&mut buf, file_schema.clone(), Some(props)).unwrap();
4984        writer.write(&batch).unwrap();
4985
4986        let metadata = writer.close().unwrap();
4987        assert_eq!(metadata.num_row_groups(), 1);
4988        let row_group = metadata.row_group(0);
4989        assert_eq!(row_group.num_columns(), 2);
4990        // Column "a" has both offset and column index, as requested
4991        assert!(row_group.column(0).offset_index_offset().is_some());
4992        assert!(row_group.column(0).column_index_offset().is_some());
4993        // Column "b" should only have offset index
4994        assert!(row_group.column(1).offset_index_offset().is_some());
4995        assert!(row_group.column(1).column_index_offset().is_none());
4996
4997        let options = ReadOptionsBuilder::new().with_page_index().build();
4998        let reader = SerializedFileReader::new_with_options(Bytes::from(buf), options).unwrap();
4999
5000        let row_group = reader.get_row_group(0).unwrap();
5001        let a_col = row_group.metadata().column(0);
5002        let b_col = row_group.metadata().column(1);
5003
5004        // Column chunk of column "a" should have chunk level statistics
5005        if let Statistics::ByteArray(byte_array_stats) = a_col.statistics().unwrap() {
5006            let min = byte_array_stats.min_opt().unwrap();
5007            let max = byte_array_stats.max_opt().unwrap();
5008
5009            assert_eq!(min.as_bytes(), b"a");
5010            assert_eq!(max.as_bytes(), b"d");
5011        } else {
5012            panic!("expecting Statistics::ByteArray");
5013        }
5014
5015        // The column chunk for column "b" shouldn't have statistics
5016        assert!(b_col.statistics().is_none());
5017
5018        let offset_index = reader.metadata().offset_index().unwrap();
5019        assert_eq!(offset_index.len(), 1); // 1 row group
5020        assert_eq!(offset_index[0].len(), 2); // 2 columns
5021
5022        let column_index = reader.metadata().column_index().unwrap();
5023        assert_eq!(column_index.len(), 1); // 1 row group
5024        assert_eq!(column_index[0].len(), 2); // 2 columns
5025
5026        let a_idx = &column_index[0][0];
5027        assert!(
5028            matches!(a_idx, ColumnIndexMetaData::BYTE_ARRAY(_)),
5029            "{a_idx:?}"
5030        );
5031        let b_idx = &column_index[0][1];
5032        assert!(matches!(b_idx, ColumnIndexMetaData::NONE), "{b_idx:?}");
5033    }
5034
5035    #[test]
5036    fn test_disabled_statistics_with_chunk() {
5037        let file_schema = Schema::new(vec![
5038            Field::new("a", DataType::Utf8, true),
5039            Field::new("b", DataType::Utf8, true),
5040        ]);
5041        let file_schema = Arc::new(file_schema);
5042
5043        let batch = RecordBatch::try_new(
5044            file_schema.clone(),
5045            vec![
5046                Arc::new(StringArray::from(vec!["a", "b", "c", "d"])) as _,
5047                Arc::new(StringArray::from(vec!["w", "x", "y", "z"])) as _,
5048            ],
5049        )
5050        .unwrap();
5051
5052        let props = WriterProperties::builder()
5053            .set_statistics_enabled(EnabledStatistics::None)
5054            .set_column_statistics_enabled("a".into(), EnabledStatistics::Chunk)
5055            .build();
5056
5057        let mut buf = Vec::with_capacity(1024);
5058        let mut writer = ArrowWriter::try_new(&mut buf, file_schema.clone(), Some(props)).unwrap();
5059        writer.write(&batch).unwrap();
5060
5061        let metadata = writer.close().unwrap();
5062        assert_eq!(metadata.num_row_groups(), 1);
5063        let row_group = metadata.row_group(0);
5064        assert_eq!(row_group.num_columns(), 2);
5065        // Column "a" should only have offset index
5066        assert!(row_group.column(0).offset_index_offset().is_some());
5067        assert!(row_group.column(0).column_index_offset().is_none());
5068        // Column "b" should only have offset index
5069        assert!(row_group.column(1).offset_index_offset().is_some());
5070        assert!(row_group.column(1).column_index_offset().is_none());
5071
5072        let options = ReadOptionsBuilder::new().with_page_index().build();
5073        let reader = SerializedFileReader::new_with_options(Bytes::from(buf), options).unwrap();
5074
5075        let row_group = reader.get_row_group(0).unwrap();
5076        let a_col = row_group.metadata().column(0);
5077        let b_col = row_group.metadata().column(1);
5078
5079        // Column chunk of column "a" should have chunk level statistics
5080        if let Statistics::ByteArray(byte_array_stats) = a_col.statistics().unwrap() {
5081            let min = byte_array_stats.min_opt().unwrap();
5082            let max = byte_array_stats.max_opt().unwrap();
5083
5084            assert_eq!(min.as_bytes(), b"a");
5085            assert_eq!(max.as_bytes(), b"d");
5086        } else {
5087            panic!("expecting Statistics::ByteArray");
5088        }
5089
5090        // The column chunk for column "b"  shouldn't have statistics
5091        assert!(b_col.statistics().is_none());
5092
5093        let column_index = reader.metadata().column_index().unwrap();
5094        assert_eq!(column_index.len(), 1); // 1 row group
5095        assert_eq!(column_index[0].len(), 2); // 2 columns
5096
5097        let a_idx = &column_index[0][0];
5098        assert!(matches!(a_idx, ColumnIndexMetaData::NONE), "{a_idx:?}");
5099        let b_idx = &column_index[0][1];
5100        assert!(matches!(b_idx, ColumnIndexMetaData::NONE), "{b_idx:?}");
5101    }
5102
5103    #[test]
5104    fn test_arrow_writer_skip_metadata() {
5105        let batch_schema = Schema::new(vec![Field::new("int32", DataType::Int32, false)]);
5106        let file_schema = Arc::new(batch_schema.clone());
5107
5108        let batch = RecordBatch::try_new(
5109            Arc::new(batch_schema),
5110            vec![Arc::new(Int32Array::from(vec![1, 2, 3, 4])) as _],
5111        )
5112        .unwrap();
5113        let skip_options = ArrowWriterOptions::new().with_skip_arrow_metadata(true);
5114
5115        let mut buf = Vec::with_capacity(1024);
5116        let mut writer =
5117            ArrowWriter::try_new_with_options(&mut buf, file_schema.clone(), skip_options).unwrap();
5118        writer.write(&batch).unwrap();
5119        writer.close().unwrap();
5120
5121        let bytes = Bytes::from(buf);
5122        let reader_builder = ParquetRecordBatchReaderBuilder::try_new(bytes).unwrap();
5123        assert_eq!(file_schema, *reader_builder.schema());
5124        if let Some(key_value_metadata) = reader_builder
5125            .metadata()
5126            .file_metadata()
5127            .key_value_metadata()
5128        {
5129            assert!(
5130                !key_value_metadata
5131                    .iter()
5132                    .any(|kv| kv.key.as_str() == ARROW_SCHEMA_META_KEY)
5133            );
5134        }
5135    }
5136
5137    #[test]
5138    fn test_arrow_writer_skip_path_in_schema() {
5139        let batch_schema = Schema::new(vec![Field::new("int32", DataType::Int32, false)]);
5140        let file_schema = Arc::new(batch_schema.clone());
5141
5142        let batch = RecordBatch::try_new(
5143            Arc::new(batch_schema),
5144            vec![Arc::new(Int32Array::from(vec![1, 2, 3, 4])) as _],
5145        )
5146        .unwrap();
5147
5148        // default options should still write path_in_schema
5149        let skip_options = ArrowWriterOptions::new();
5150
5151        let mut buf = Vec::with_capacity(1024);
5152        let mut writer =
5153            ArrowWriter::try_new_with_options(&mut buf, file_schema.clone(), skip_options).unwrap();
5154        writer.write(&batch).unwrap();
5155        writer.close().unwrap();
5156
5157        // override to not write path_in_schema
5158        let skip_options = ArrowWriterOptions::new().with_properties(
5159            WriterProperties::builder()
5160                .set_write_path_in_schema(false)
5161                .build(),
5162        );
5163
5164        let mut buf2 = Vec::with_capacity(1024);
5165        let mut writer =
5166            ArrowWriter::try_new_with_options(&mut buf2, file_schema.clone(), skip_options)
5167                .unwrap();
5168        writer.write(&batch).unwrap();
5169        writer.close().unwrap();
5170
5171        // buf2 should be a bit smaller due to lack of path_in_schema
5172        assert!(buf.len() > buf2.len());
5173    }
5174
5175    #[test]
5176    fn mismatched_schemas() {
5177        let batch_schema = Schema::new(vec![Field::new("count", DataType::Int32, false)]);
5178        let file_schema = Arc::new(Schema::new(vec![Field::new(
5179            "temperature",
5180            DataType::Float64,
5181            false,
5182        )]));
5183
5184        let batch = RecordBatch::try_new(
5185            Arc::new(batch_schema),
5186            vec![Arc::new(Int32Array::from(vec![1, 2, 3, 4])) as _],
5187        )
5188        .unwrap();
5189
5190        let mut buf = Vec::with_capacity(1024);
5191        let mut writer = ArrowWriter::try_new(&mut buf, file_schema.clone(), None).unwrap();
5192
5193        let err = writer.write(&batch).unwrap_err().to_string();
5194        assert_eq!(
5195            err,
5196            "Arrow: Incompatible type. Field 'temperature' has type Float64, array has type Int32"
5197        );
5198    }
5199
5200    #[test]
5201    // https://github.com/apache/arrow-rs/issues/6988
5202    fn test_roundtrip_empty_schema() {
5203        // create empty record batch with empty schema
5204        let empty_batch = RecordBatch::try_new_with_options(
5205            Arc::new(Schema::empty()),
5206            vec![],
5207            &RecordBatchOptions::default().with_row_count(Some(0)),
5208        )
5209        .unwrap();
5210
5211        // write to parquet
5212        let mut parquet_bytes: Vec<u8> = Vec::new();
5213        let mut writer =
5214            ArrowWriter::try_new(&mut parquet_bytes, empty_batch.schema(), None).unwrap();
5215        writer.write(&empty_batch).unwrap();
5216        writer.close().unwrap();
5217
5218        // read from parquet
5219        let bytes = Bytes::from(parquet_bytes);
5220        let reader = ParquetRecordBatchReaderBuilder::try_new(bytes).unwrap();
5221        assert_eq!(reader.schema(), &empty_batch.schema());
5222        let batches: Vec<_> = reader
5223            .build()
5224            .unwrap()
5225            .collect::<ArrowResult<Vec<_>>>()
5226            .unwrap();
5227        assert_eq!(batches.len(), 0);
5228    }
5229
5230    #[test]
5231    fn test_page_stats_not_written_by_default() {
5232        let string_field = Field::new("a", DataType::Utf8, false);
5233        let schema = Schema::new(vec![string_field]);
5234        let raw_string_values = vec!["Blart Versenwald III"];
5235        let string_values = StringArray::from(raw_string_values.clone());
5236        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(string_values)]).unwrap();
5237
5238        let props = WriterProperties::builder()
5239            .set_statistics_enabled(EnabledStatistics::Page)
5240            .set_dictionary_enabled(false)
5241            .set_encoding(Encoding::PLAIN)
5242            .set_compression(crate::basic::Compression::UNCOMPRESSED)
5243            .build();
5244
5245        let file = roundtrip_opts(&batch, props);
5246
5247        // read file and decode page headers
5248        // Note: use the thrift API as there is no Rust API to access the statistics in the page headers
5249
5250        // decode first page header
5251        let first_page = &file[4..];
5252        let mut prot = ThriftSliceInputProtocol::new(first_page);
5253        let hdr = PageHeader::read_thrift(&mut prot).unwrap();
5254        let stats = hdr.data_page_header.unwrap().statistics;
5255
5256        assert!(stats.is_none());
5257    }
5258
5259    #[test]
5260    fn test_page_stats_when_enabled() {
5261        let string_field = Field::new("a", DataType::Utf8, false);
5262        let schema = Schema::new(vec![string_field]);
5263        let raw_string_values = vec!["Blart Versenwald III", "Andrew Lamb"];
5264        let string_values = StringArray::from(raw_string_values.clone());
5265        let batch = RecordBatch::try_new(Arc::new(schema), vec![Arc::new(string_values)]).unwrap();
5266
5267        let props = WriterProperties::builder()
5268            .set_statistics_enabled(EnabledStatistics::Page)
5269            .set_dictionary_enabled(false)
5270            .set_encoding(Encoding::PLAIN)
5271            .set_write_page_header_statistics(true)
5272            .set_compression(crate::basic::Compression::UNCOMPRESSED)
5273            .build();
5274
5275        let file = roundtrip_opts(&batch, props);
5276
5277        // read file and decode page headers
5278        // Note: use the thrift API as there is no Rust API to access the statistics in the page headers
5279
5280        // decode first page header
5281        let first_page = &file[4..];
5282        let mut prot = ThriftSliceInputProtocol::new(first_page);
5283        let hdr = PageHeader::read_thrift(&mut prot).unwrap();
5284        let stats = hdr.data_page_header.unwrap().statistics;
5285
5286        let stats = stats.unwrap();
5287        // check that min/max were actually written to the page
5288        assert!(stats.is_max_value_exact.unwrap());
5289        assert!(stats.is_min_value_exact.unwrap());
5290        assert_eq!(stats.max_value.unwrap(), "Blart Versenwald III".as_bytes());
5291        assert_eq!(stats.min_value.unwrap(), "Andrew Lamb".as_bytes());
5292    }
5293
5294    #[test]
5295    fn test_page_stats_truncation() {
5296        let string_field = Field::new("a", DataType::Utf8, false);
5297        let binary_field = Field::new("b", DataType::Binary, false);
5298        let schema = Schema::new(vec![string_field, binary_field]);
5299
5300        let raw_string_values = vec!["Blart Versenwald III"];
5301        let raw_binary_values = [b"Blart Versenwald III".to_vec()];
5302        let raw_binary_value_refs = raw_binary_values
5303            .iter()
5304            .map(|x| x.as_slice())
5305            .collect::<Vec<_>>();
5306
5307        let string_values = StringArray::from(raw_string_values.clone());
5308        let binary_values = BinaryArray::from(raw_binary_value_refs);
5309        let batch = RecordBatch::try_new(
5310            Arc::new(schema),
5311            vec![Arc::new(string_values), Arc::new(binary_values)],
5312        )
5313        .unwrap();
5314
5315        let props = WriterProperties::builder()
5316            .set_statistics_truncate_length(Some(2))
5317            .set_dictionary_enabled(false)
5318            .set_encoding(Encoding::PLAIN)
5319            .set_write_page_header_statistics(true)
5320            .set_compression(crate::basic::Compression::UNCOMPRESSED)
5321            .build();
5322
5323        let file = roundtrip_opts(&batch, props);
5324
5325        // read file and decode page headers
5326        // Note: use the thrift API as there is no Rust API to access the statistics in the page headers
5327
5328        // decode first page header
5329        let first_page = &file[4..];
5330        let mut prot = ThriftSliceInputProtocol::new(first_page);
5331        let hdr = PageHeader::read_thrift(&mut prot).unwrap();
5332        let stats = hdr.data_page_header.unwrap().statistics;
5333        assert!(stats.is_some());
5334        let stats = stats.unwrap();
5335        // check that min/max were properly truncated
5336        assert!(!stats.is_max_value_exact.unwrap());
5337        assert!(!stats.is_min_value_exact.unwrap());
5338        assert_eq!(stats.max_value.unwrap(), "Bm".as_bytes());
5339        assert_eq!(stats.min_value.unwrap(), "Bl".as_bytes());
5340
5341        // check second page now
5342        let second_page = &prot.as_slice()[hdr.compressed_page_size as usize..];
5343        let mut prot = ThriftSliceInputProtocol::new(second_page);
5344        let hdr = PageHeader::read_thrift(&mut prot).unwrap();
5345        let stats = hdr.data_page_header.unwrap().statistics;
5346        assert!(stats.is_some());
5347        let stats = stats.unwrap();
5348        // check that min/max were properly truncated
5349        assert!(!stats.is_max_value_exact.unwrap());
5350        assert!(!stats.is_min_value_exact.unwrap());
5351        assert_eq!(stats.max_value.unwrap(), "Bm".as_bytes());
5352        assert_eq!(stats.min_value.unwrap(), "Bl".as_bytes());
5353    }
5354
5355    #[test]
5356    fn test_page_encoding_statistics_roundtrip() {
5357        let batch_schema = Schema::new(vec![Field::new(
5358            "int32",
5359            arrow_schema::DataType::Int32,
5360            false,
5361        )]);
5362
5363        let batch = RecordBatch::try_new(
5364            Arc::new(batch_schema.clone()),
5365            vec![Arc::new(Int32Array::from(vec![1, 2, 3, 4])) as _],
5366        )
5367        .unwrap();
5368
5369        let mut file: File = tempfile::tempfile().unwrap();
5370        let mut writer = ArrowWriter::try_new(&mut file, Arc::new(batch_schema), None).unwrap();
5371        writer.write(&batch).unwrap();
5372        let file_metadata = writer.close().unwrap();
5373
5374        assert_eq!(file_metadata.num_row_groups(), 1);
5375        assert_eq!(file_metadata.row_group(0).num_columns(), 1);
5376        assert!(
5377            file_metadata
5378                .row_group(0)
5379                .column(0)
5380                .page_encoding_stats()
5381                .is_some()
5382        );
5383        let chunk_page_stats = file_metadata
5384            .row_group(0)
5385            .column(0)
5386            .page_encoding_stats()
5387            .unwrap();
5388
5389        // check that the read metadata is also correct
5390        let options = ReadOptionsBuilder::new()
5391            .with_page_index()
5392            .with_encoding_stats_as_mask(false)
5393            .build();
5394        let reader = SerializedFileReader::new_with_options(file, options).unwrap();
5395
5396        let rowgroup = reader.get_row_group(0).expect("row group missing");
5397        assert_eq!(rowgroup.num_columns(), 1);
5398        let column = rowgroup.metadata().column(0);
5399        assert!(column.page_encoding_stats().is_some());
5400        let file_page_stats = column.page_encoding_stats().unwrap();
5401        assert_eq!(chunk_page_stats, file_page_stats);
5402    }
5403
5404    #[test]
5405    fn test_different_dict_page_size_limit() {
5406        let array = Arc::new(Int64Array::from_iter(0..1024 * 1024));
5407        let schema = Arc::new(Schema::new(vec![
5408            Field::new("col0", arrow_schema::DataType::Int64, false),
5409            Field::new("col1", arrow_schema::DataType::Int64, false),
5410        ]));
5411        let batch =
5412            arrow_array::RecordBatch::try_new(schema.clone(), vec![array.clone(), array]).unwrap();
5413
5414        let props = WriterProperties::builder()
5415            .set_dictionary_page_size_limit(1024 * 1024)
5416            .set_column_dictionary_page_size_limit(ColumnPath::from("col1"), 1024 * 1024 * 4)
5417            .build();
5418        let mut writer = ArrowWriter::try_new(Vec::new(), schema, Some(props)).unwrap();
5419        writer.write(&batch).unwrap();
5420        let data = Bytes::from(writer.into_inner().unwrap());
5421
5422        let mut metadata = ParquetMetaDataReader::new();
5423        metadata.try_parse(&data).unwrap();
5424        let metadata = metadata.finish().unwrap();
5425        let col0_meta = metadata.row_group(0).column(0);
5426        let col1_meta = metadata.row_group(0).column(1);
5427
5428        let get_dict_page_size = move |meta: &ColumnChunkMetaData| {
5429            let mut reader =
5430                SerializedPageReader::new(Arc::new(data.clone()), meta, 0, None).unwrap();
5431            let page = reader.get_next_page().unwrap().unwrap();
5432            match page {
5433                Page::DictionaryPage { buf, .. } => buf.len(),
5434                _ => panic!("expected DictionaryPage"),
5435            }
5436        };
5437
5438        assert_eq!(get_dict_page_size(col0_meta), 1024 * 1024);
5439        assert_eq!(get_dict_page_size(col1_meta), 1024 * 1024 * 4);
5440    }
5441
5442    #[test]
5443    fn test_arrow_writer_granular_mode_roundtrip() {
5444        // Granular mode subdivides chunks and writes more pages than the
5445        // default batched path. Make sure the data we write back is
5446        // bit-identical to what went in — page-count assertions elsewhere
5447        // only prove pages were cut, not that the encoded data is correct.
5448        //
5449        // Mix value sizes so that the cumulative-byte-budget cutoff
5450        // lands mid-chunk, exercising both batched and granular paths
5451        // within the same `write_batch_internal` call.
5452        let small = "tiny".to_string();
5453        let big = "x".repeat(64 * 1024);
5454        let strings: Vec<String> = (0..256)
5455            .map(|i| {
5456                if i % 16 == 0 {
5457                    big.clone()
5458                } else {
5459                    small.clone()
5460                }
5461            })
5462            .collect();
5463
5464        let schema = Arc::new(Schema::new(vec![Field::new(
5465            "col",
5466            ArrowDataType::Utf8,
5467            false,
5468        )]));
5469        let batch = RecordBatch::try_new(
5470            schema.clone(),
5471            vec![Arc::new(StringArray::from(strings.clone())) as _],
5472        )
5473        .unwrap();
5474
5475        let props = WriterProperties::builder()
5476            .set_dictionary_enabled(false)
5477            .set_data_page_size_limit(16 * 1024)
5478            .build();
5479        let mut writer = ArrowWriter::try_new(Vec::new(), schema, Some(props)).unwrap();
5480        writer.write(&batch).unwrap();
5481        let data = Bytes::from(writer.into_inner().unwrap());
5482
5483        let mut reader = ParquetRecordBatchReader::try_new(data, 1024).unwrap();
5484        let read = reader.next().unwrap().unwrap();
5485        assert!(reader.next().is_none(), "expected one batch");
5486        let col = read
5487            .column(0)
5488            .as_any()
5489            .downcast_ref::<StringArray>()
5490            .unwrap();
5491        assert_eq!(col.len(), strings.len());
5492        for (i, expected) in strings.iter().enumerate() {
5493            assert_eq!(
5494                col.value(i),
5495                expected.as_str(),
5496                "value mismatch at index {i}"
5497            );
5498        }
5499    }
5500
5501    #[test]
5502    fn test_arrow_writer_all_null_string_column() {
5503        // The `LevelDataRef::value_count` Uniform branch with
5504        // `value != max_def` (entirely-null chunk) must return 0 so the
5505        // sub-batch sizer short-circuits to batch mode without trying
5506        // to estimate byte budgets for non-existent values.
5507        let num_rows = 1024;
5508        let schema = Arc::new(Schema::new(vec![Field::new(
5509            "col",
5510            ArrowDataType::Utf8,
5511            true,
5512        )]));
5513        let nulls: Vec<Option<&str>> = vec![None; num_rows];
5514        let batch = RecordBatch::try_new(
5515            schema.clone(),
5516            vec![Arc::new(StringArray::from(nulls)) as _],
5517        )
5518        .unwrap();
5519
5520        let props = WriterProperties::builder()
5521            .set_dictionary_enabled(false)
5522            .set_data_page_size_limit(16 * 1024)
5523            .build();
5524        let mut writer = ArrowWriter::try_new(Vec::new(), schema, Some(props)).unwrap();
5525        writer.write(&batch).unwrap();
5526        let data = Bytes::from(writer.into_inner().unwrap());
5527
5528        // Re-parse the file: row group has one column, every row is
5529        // null, all data pages report `num_rows / page_count` rows.
5530        let mut metadata = ParquetMetaDataReader::new();
5531        metadata.try_parse(&data).unwrap();
5532        let metadata = metadata.finish().unwrap();
5533        let row_group = metadata.row_group(0);
5534        let col_meta = row_group.column(0);
5535        assert_eq!(row_group.num_rows() as usize, num_rows);
5536        // Statistics record `null_count = num_rows` — proves every value
5537        // was written as null.
5538        if let Some(stats) = col_meta.statistics() {
5539            assert_eq!(
5540                stats.null_count_opt().unwrap_or(0) as usize,
5541                num_rows,
5542                "expected all-null column to report null_count = num_rows"
5543            );
5544        }
5545
5546        let mut reader =
5547            SerializedPageReader::new(Arc::new(data.clone()), col_meta, num_rows, None).unwrap();
5548        let mut total_values = 0u32;
5549        while let Some(page) = reader.get_next_page().unwrap() {
5550            if matches!(page, Page::DataPage { .. } | Page::DataPageV2 { .. }) {
5551                total_values += page.num_values();
5552            }
5553        }
5554        assert_eq!(
5555            total_values as usize, num_rows,
5556            "expected every level position to be represented in some page"
5557        );
5558    }
5559
5560    struct WriteBatchesShape {
5561        num_batches: usize,
5562        rows_per_batch: usize,
5563        row_size: usize,
5564    }
5565
5566    /// Helper function to write batches with the provided `WriteBatchesShape` into an `ArrowWriter`
5567    fn write_batches(
5568        WriteBatchesShape {
5569            num_batches,
5570            rows_per_batch,
5571            row_size,
5572        }: WriteBatchesShape,
5573        props: WriterProperties,
5574    ) -> ParquetRecordBatchReaderBuilder<File> {
5575        let schema = Arc::new(Schema::new(vec![Field::new(
5576            "str",
5577            ArrowDataType::Utf8,
5578            false,
5579        )]));
5580        let file = tempfile::tempfile().unwrap();
5581        let mut writer =
5582            ArrowWriter::try_new(file.try_clone().unwrap(), schema.clone(), Some(props)).unwrap();
5583
5584        for batch_idx in 0..num_batches {
5585            let strings: Vec<String> = (0..rows_per_batch)
5586                .map(|i| format!("{:0>width$}", batch_idx * 10 + i, width = row_size))
5587                .collect();
5588            let array = StringArray::from(strings);
5589            let batch = RecordBatch::try_new(schema.clone(), vec![Arc::new(array)]).unwrap();
5590            writer.write(&batch).unwrap();
5591        }
5592        writer.close().unwrap();
5593        ParquetRecordBatchReaderBuilder::try_new(file).unwrap()
5594    }
5595
5596    #[test]
5597    // When both limits are None, all data should go into a single row group
5598    fn test_row_group_limit_none_writes_single_row_group() {
5599        let props = WriterProperties::builder()
5600            .set_max_row_group_row_count(None)
5601            .set_max_row_group_bytes(None)
5602            .build();
5603
5604        let builder = write_batches(
5605            WriteBatchesShape {
5606                num_batches: 1,
5607                rows_per_batch: 1000,
5608                row_size: 4,
5609            },
5610            props,
5611        );
5612
5613        assert_eq!(
5614            &row_group_sizes(builder.metadata()),
5615            &[1000],
5616            "With no limits, all rows should be in a single row group"
5617        );
5618    }
5619
5620    #[test]
5621    // When only max_row_group_size is set, respect the row limit
5622    fn test_row_group_limit_rows_only() {
5623        let props = WriterProperties::builder()
5624            .set_max_row_group_row_count(Some(300))
5625            .set_max_row_group_bytes(None)
5626            .build();
5627
5628        let builder = write_batches(
5629            WriteBatchesShape {
5630                num_batches: 1,
5631                rows_per_batch: 1000,
5632                row_size: 4,
5633            },
5634            props,
5635        );
5636
5637        assert_eq!(
5638            &row_group_sizes(builder.metadata()),
5639            &[300, 300, 300, 100],
5640            "Row groups should be split by row count"
5641        );
5642    }
5643
5644    #[test]
5645    // When only max_row_group_bytes is set, respect the byte limit
5646    fn test_row_group_limit_bytes_only() {
5647        let props = WriterProperties::builder()
5648            .set_max_row_group_row_count(None)
5649            // Set byte limit to approximately fit ~30 rows worth of data (~100 bytes each)
5650            .set_max_row_group_bytes(Some(3500))
5651            .build();
5652
5653        let builder = write_batches(
5654            WriteBatchesShape {
5655                num_batches: 10,
5656                rows_per_batch: 10,
5657                row_size: 100,
5658            },
5659            props,
5660        );
5661
5662        let sizes = row_group_sizes(builder.metadata());
5663
5664        assert!(
5665            sizes.len() > 1,
5666            "Should have multiple row groups due to byte limit, got {sizes:?}",
5667        );
5668
5669        let total_rows: i64 = sizes.iter().sum();
5670        assert_eq!(total_rows, 100, "Total rows should be preserved");
5671    }
5672
5673    #[test]
5674    // If an in-progress row group is already oversized, it should be flushed before writing more.
5675    fn test_row_group_limit_bytes_flushes_when_current_group_already_too_large() {
5676        let schema = Arc::new(Schema::new(vec![Field::new(
5677            "str",
5678            ArrowDataType::Utf8,
5679            false,
5680        )]));
5681        let file = tempfile::tempfile().unwrap();
5682
5683        // Start with no byte limit so we can intentionally build an oversized in-progress row group.
5684        let props = WriterProperties::builder()
5685            .set_max_row_group_row_count(None)
5686            .set_max_row_group_bytes(None)
5687            .build();
5688        let mut writer =
5689            ArrowWriter::try_new(file.try_clone().unwrap(), schema.clone(), Some(props)).unwrap();
5690
5691        let first_array = StringArray::from(
5692            (0..10)
5693                .map(|i| format!("{:0>100}", i))
5694                .collect::<Vec<String>>(),
5695        );
5696        let first_batch =
5697            RecordBatch::try_new(schema.clone(), vec![Arc::new(first_array)]).unwrap();
5698        writer.write(&first_batch).unwrap();
5699        assert_eq!(writer.in_progress_rows(), 10);
5700
5701        // Tighten the limit below the current in-progress bytes to exercise:
5702        // `if current_bytes >= max_bytes { self.flush()?; ... }`
5703        writer.max_row_group_bytes = Some(1);
5704
5705        let second_array = StringArray::from(vec!["x".to_string()]);
5706        let second_batch =
5707            RecordBatch::try_new(schema.clone(), vec![Arc::new(second_array)]).unwrap();
5708        writer.write(&second_batch).unwrap();
5709        writer.close().unwrap();
5710        let builder = ParquetRecordBatchReaderBuilder::try_new(file).unwrap();
5711
5712        assert_eq!(
5713            &row_group_sizes(builder.metadata()),
5714            &[10, 1],
5715            "The second write should flush an oversized in-progress row group first",
5716        );
5717    }
5718
5719    #[test]
5720    // When both limits are set, the row limit triggers first
5721    fn test_row_group_limit_both_row_wins_single_batch() {
5722        let props = WriterProperties::builder()
5723            .set_max_row_group_row_count(Some(200)) // Will trigger at 200 rows
5724            .set_max_row_group_bytes(Some(1024 * 1024)) // 1MB - won't trigger for small int data
5725            .build();
5726
5727        let builder = write_batches(
5728            WriteBatchesShape {
5729                num_batches: 1,
5730                row_size: 4,
5731                rows_per_batch: 1000,
5732            },
5733            props,
5734        );
5735
5736        assert_eq!(
5737            &row_group_sizes(builder.metadata()),
5738            &[200, 200, 200, 200, 200],
5739            "Row limit should trigger before byte limit"
5740        );
5741    }
5742
5743    #[test]
5744    // When both limits are set, the row limit triggers first
5745    fn test_row_group_limit_both_row_wins_multiple_batches() {
5746        let props = WriterProperties::builder()
5747            .set_max_row_group_row_count(Some(5)) // Will trigger every 5 rows
5748            .set_max_row_group_bytes(Some(9999)) // Won't trigger
5749            .build();
5750
5751        let builder = write_batches(
5752            WriteBatchesShape {
5753                num_batches: 10,
5754                rows_per_batch: 10,
5755                row_size: 100,
5756            },
5757            props,
5758        );
5759
5760        assert_eq!(
5761            &row_group_sizes(builder.metadata()),
5762            &[5; 20],
5763            "Row limit should trigger before byte limit"
5764        );
5765    }
5766
5767    #[test]
5768    // When both limits are set, the byte limit triggers first
5769    fn test_row_group_limit_both_bytes_wins() {
5770        let props = WriterProperties::builder()
5771            .set_max_row_group_row_count(Some(1000)) // Won't trigger for 100 rows
5772            .set_max_row_group_bytes(Some(3500)) // Will trigger at ~30-35 rows
5773            .build();
5774
5775        let builder = write_batches(
5776            WriteBatchesShape {
5777                num_batches: 10,
5778                rows_per_batch: 10,
5779                row_size: 100,
5780            },
5781            props,
5782        );
5783
5784        let sizes = row_group_sizes(builder.metadata());
5785
5786        assert!(
5787            sizes.len() > 1,
5788            "Byte limit should trigger before row limit, got {sizes:?}",
5789        );
5790
5791        assert!(
5792            sizes.iter().all(|&s| s < 1000),
5793            "No row group should hit the row limit"
5794        );
5795
5796        let total_rows: i64 = sizes.iter().sum();
5797        assert_eq!(total_rows, 100, "Total rows should be preserved");
5798    }
5799
5800    #[test]
5801    fn arrow_column_chunk_close_mut_drops_column_index() {
5802        use crate::arrow::ArrowSchemaConverter;
5803        use crate::file::writer::SerializedFileWriter;
5804
5805        let schema = Arc::new(Schema::new(vec![Field::new("i", DataType::Int32, false)]));
5806        let props = Arc::new(
5807            WriterProperties::builder()
5808                .set_statistics_enabled(EnabledStatistics::Page)
5809                .build(),
5810        );
5811        let parquet_schema = ArrowSchemaConverter::new()
5812            .with_coerce_types(props.coerce_types())
5813            .convert(&schema)
5814            .unwrap();
5815
5816        let mut buf = Vec::with_capacity(1024);
5817        let mut writer =
5818            SerializedFileWriter::new(&mut buf, parquet_schema.root_schema_ptr(), props.clone())
5819                .unwrap();
5820
5821        let factory = ArrowRowGroupWriterFactory::new(&writer, Arc::clone(&schema));
5822        let mut col_writers = factory.create_column_writers(0).unwrap();
5823        let arr: ArrayRef = Arc::new(Int32Array::from_iter_values(0..64));
5824        for leaves in compute_leaves(schema.field(0), &arr).unwrap() {
5825            col_writers[0].write(&leaves).unwrap();
5826        }
5827        let mut chunk = col_writers.pop().unwrap().close().unwrap();
5828
5829        // Immutable accessor exposes the close result produced at close time.
5830        assert!(
5831            chunk.close().column_index.is_some(),
5832            "EnabledStatistics::Page should produce a column_index"
5833        );
5834
5835        // Mutable accessor lets callers drop the page-level index before append.
5836        chunk.close_mut().column_index = None;
5837        assert!(chunk.close().column_index.is_none());
5838
5839        let mut rg = writer.next_row_group().unwrap();
5840        chunk.append_to_row_group(&mut rg).unwrap();
5841        rg.close().unwrap();
5842        let file_meta = writer.close().unwrap();
5843
5844        // After dropping column_index, the resulting file records no column
5845        // index offset/length for this chunk.
5846        let cc = file_meta.row_group(0).column(0);
5847        assert!(cc.column_index_range().is_none());
5848    }
5849
5850    /// Writes a single-column RecordBatch to an in-memory Parquet buffer.
5851    fn write_column_to_bytes(array: ArrayRef) -> Bytes {
5852        let schema = Arc::new(Schema::new(vec![Field::new(
5853            "col",
5854            array.data_type().clone(),
5855            true,
5856        )]));
5857        let buf = get_bytes_after_close(
5858            schema.clone(),
5859            &RecordBatch::try_new(schema, vec![array]).unwrap(),
5860        );
5861        Bytes::from(buf)
5862    }
5863
5864    /// Reads column 0 from a single-row-group Parquet buffer, projecting it with the given schema.
5865    /// Passing a flat schema when the buffer was written from a REE array lets callers decode
5866    /// the physical values without the run-end encoding wrapper.
5867    fn read_column_with_schema(bytes: Bytes, schema: SchemaRef) -> ArrayRef {
5868        let opts = crate::arrow::arrow_reader::ArrowReaderOptions::new().with_schema(schema);
5869        ParquetRecordBatchReaderBuilder::try_new_with_options(bytes, opts)
5870            .unwrap()
5871            .build()
5872            .unwrap()
5873            .next()
5874            .unwrap()
5875            .unwrap()
5876            .column(0)
5877            .clone()
5878    }
5879
5880    fn ree_write_read_roundtrip(ree: ArrayRef, flat: ArrayRef) {
5881        let flat_schema = Arc::new(Schema::new(vec![Field::new(
5882            "col",
5883            flat.data_type().clone(),
5884            true,
5885        )]));
5886        let ree_bytes = write_column_to_bytes(ree);
5887        let flat_bytes = write_column_to_bytes(flat.clone());
5888        assert_eq!(
5889            ree_bytes, flat_bytes,
5890            "REE and flat bytes should be identical"
5891        );
5892
5893        let decoded_ree = read_column_with_schema(ree_bytes, flat_schema.clone());
5894        let decoded_flat = read_column_with_schema(flat_bytes, flat_schema);
5895
5896        assert_eq!(decoded_ree.as_ref(), flat.as_ref());
5897        assert_eq!(decoded_ree.as_ref(), decoded_flat.as_ref());
5898    }
5899
5900    #[test]
5901    fn ree_string() {
5902        let ree: ArrayRef = Arc::new(
5903            [Some("a"), Some("a"), None, Some("b"), Some("b")]
5904                .into_iter()
5905                .collect::<Int32RunArray>(),
5906        );
5907        let flat: ArrayRef = Arc::new(StringArray::from(vec![
5908            Some("a"),
5909            Some("a"),
5910            None,
5911            Some("b"),
5912            Some("b"),
5913        ]));
5914        ree_write_read_roundtrip(ree, flat);
5915    }
5916
5917    #[test]
5918    fn ree_int32() {
5919        let mut b = PrimitiveRunBuilder::<Int32Type, Int32Type>::new();
5920        for v in [Some(1), Some(1), None, Some(2), Some(2)] {
5921            b.append_option(v);
5922        }
5923        let ree: ArrayRef = Arc::new(b.finish());
5924        let flat: ArrayRef = Arc::new(Int32Array::from(vec![
5925            Some(1),
5926            Some(1),
5927            None,
5928            Some(2),
5929            Some(2),
5930        ]));
5931        ree_write_read_roundtrip(ree, flat);
5932    }
5933
5934    #[test]
5935    fn ree_bool() {
5936        // run_ends [3, 5, 7] → [T,T,T, null,null, F,F]
5937        let ree: ArrayRef = Arc::new(
5938            RunArray::try_new(
5939                &Int32Array::from(vec![3, 5, 7]),
5940                &BooleanArray::from(vec![Some(true), None, Some(false)]),
5941            )
5942            .unwrap(),
5943        );
5944        let flat: ArrayRef = Arc::new(BooleanArray::from(vec![
5945            Some(true),
5946            Some(true),
5947            Some(true),
5948            None,
5949            None,
5950            Some(false),
5951            Some(false),
5952        ]));
5953        ree_write_read_roundtrip(ree, flat);
5954    }
5955
5956    #[test]
5957    fn ree_fixed_size_binary() {
5958        let mk = |vals: &[Option<&[u8]>]| -> FixedSizeBinaryArray {
5959            let mut b = FixedSizeBinaryBuilder::new(2);
5960            for v in vals {
5961                match v {
5962                    Some(x) => b.append_value(x).unwrap(),
5963                    None => b.append_null(),
5964                }
5965            }
5966            b.finish()
5967        };
5968        // run_ends [2, 4, 6] → [aa,aa, null,null, bb,bb]
5969        let ree: ArrayRef = Arc::new(
5970            RunArray::try_new(
5971                &Int32Array::from(vec![2, 4, 6]),
5972                &mk(&[Some(b"aa"), None, Some(b"bb")]),
5973            )
5974            .unwrap(),
5975        );
5976        let flat: ArrayRef = Arc::new(mk(&[
5977            Some(b"aa"),
5978            Some(b"aa"),
5979            None,
5980            None,
5981            Some(b"bb"),
5982            Some(b"bb"),
5983        ]));
5984        ree_write_read_roundtrip(ree, flat);
5985    }
5986
5987    #[test]
5988    fn ree_single_run() {
5989        let ree: ArrayRef = Arc::new(["x", "x", "x"].into_iter().collect::<Int32RunArray>());
5990        let flat: ArrayRef = Arc::new(StringArray::from(vec!["x", "x", "x"]));
5991        ree_write_read_roundtrip(ree, flat);
5992    }
5993
5994    #[test]
5995    fn ree_float32() {
5996        // run_ends [2, 4, 5] → [1.0, 1.0, null, null, 2.5]
5997        let ree: ArrayRef = Arc::new(
5998            RunArray::try_new(
5999                &Int32Array::from(vec![2, 4, 5]),
6000                &Float32Array::from(vec![Some(1.0_f32), None, Some(2.5_f32)]),
6001            )
6002            .unwrap(),
6003        );
6004        let flat: ArrayRef = Arc::new(Float32Array::from(vec![
6005            Some(1.0_f32),
6006            Some(1.0_f32),
6007            None,
6008            None,
6009            Some(2.5_f32),
6010        ]));
6011        ree_write_read_roundtrip(ree, flat);
6012    }
6013
6014    #[test]
6015    fn ree_sliced() {
6016        // A sliced (non-zero offset) REE array: verify that get_physical_index
6017        // correctly accounts for the logical offset when expanding.
6018        // Full array: run_ends [3, 5, 7] → [a,a,a, b,b, c,c]
6019        // After slice(2, 5) the logical view is [a, b, b, c, c].
6020        let full: ArrayRef = Arc::new(
6021            RunArray::try_new(
6022                &Int32Array::from(vec![3, 5, 7]),
6023                &StringArray::from(vec!["a", "b", "c"]),
6024            )
6025            .unwrap(),
6026        );
6027        let sliced = full.slice(2, 5);
6028        let flat: ArrayRef = Arc::new(StringArray::from(vec!["a", "b", "b", "c", "c"]));
6029        ree_write_read_roundtrip(sliced, flat);
6030    }
6031
6032    #[test]
6033    fn ree_struct_with_ree_child() {
6034        // Struct with a REE string field and a REE int field — confirms
6035        // recursion visits every child and each collapses to the right leaf type.
6036        let run_ends = Int32Array::from(vec![2i32, 3, 5]);
6037
6038        let col_a: ArrayRef = Arc::new(
6039            RunArray::try_new(
6040                &run_ends,
6041                &StringArray::from(vec![Some("foo"), None, Some("bar")]),
6042            )
6043            .unwrap(),
6044        );
6045        let col_b: ArrayRef = Arc::new(
6046            RunArray::try_new(&run_ends, &Int32Array::from(vec![Some(1), None, Some(2)])).unwrap(),
6047        );
6048
6049        let struct_array: ArrayRef = Arc::new(StructArray::new(
6050            Fields::from(vec![
6051                Field::new("a", col_a.data_type().clone(), true),
6052                Field::new("b", col_b.data_type().clone(), true),
6053            ]),
6054            vec![col_a, col_b],
6055            None,
6056        ));
6057
6058        let schema = Arc::new(Schema::new(vec![Field::new(
6059            "row",
6060            struct_array.data_type().clone(),
6061            true,
6062        )]));
6063        let batch = RecordBatch::try_new(schema.clone(), vec![struct_array]).unwrap();
6064
6065        let mut buf = Vec::new();
6066        let mut writer = ArrowWriter::try_new(&mut buf, schema, None).unwrap();
6067        writer.write(&batch).unwrap();
6068        let metadata = writer.close().unwrap();
6069
6070        let parquet_schema = metadata.file_metadata().schema_descr();
6071        assert_eq!(parquet_schema.num_columns(), 2);
6072        assert_eq!(
6073            parquet_schema.column(0).physical_type(),
6074            crate::basic::Type::BYTE_ARRAY
6075        );
6076        assert_eq!(parquet_schema.column(0).path().string(), "row.a");
6077        assert_eq!(
6078            parquet_schema.column(1).physical_type(),
6079            crate::basic::Type::INT32
6080        );
6081        assert_eq!(parquet_schema.column(1).path().string(), "row.b");
6082    }
6083}