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