This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new d89b3b9ae12 Document parquet ArrowWriter type limitations (#5875)
d89b3b9ae12 is described below
commit d89b3b9ae12b15969476ad985e8e5ae0dc0013fa
Author: Andrew Lamb <[email protected]>
AuthorDate: Sat Jun 15 13:22:38 2024 -0400
Document parquet ArrowWriter type limitations (#5875)
* Document parquet ArrowWriter type limitations
* fix links
---
parquet/src/arrow/arrow_writer/mod.rs | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/parquet/src/arrow/arrow_writer/mod.rs
b/parquet/src/arrow/arrow_writer/mod.rs
index 9d48ea9e463..0beb93f80a5 100644
--- a/parquet/src/arrow/arrow_writer/mod.rs
+++ b/parquet/src/arrow/arrow_writer/mod.rs
@@ -107,6 +107,20 @@ mod levels;
/// }
/// ```
///
+/// ## Type Support
+///
+/// The writer supports writing all Arrow [`DataType`]s that have a direct
mapping to
+/// Parquet types including [`StructArray`] and [`ListArray`].
+///
+/// The following are not supported:
+///
+/// * [`IntervalMonthDayNanoArray`]: Parquet does not [support nanosecond
intervals].
+///
+/// [`DataType`]:
https://docs.rs/arrow/latest/arrow/datatypes/enum.DataType.html
+/// [`StructArray`]:
https://docs.rs/arrow/latest/arrow/array/struct.StructArray.html
+/// [`ListArray`]: https://docs.rs/arrow/latest/arrow/array/type.ListArray.html
+/// [`IntervalMonthDayNanoArray`]:
https://docs.rs/arrow/latest/arrow/array/type.IntervalMonthDayNanoArray.html
+/// [support nanosecond intervals]:
https://github.com/apache/parquet-format/blob/master/LogicalTypes.md#interval
pub struct ArrowWriter<W: Write> {
/// Underlying Parquet writer
writer: SerializedFileWriter<W>,
