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