From aa2feae644d7ce3cde45152e63435e7a29d742fc Mon Sep 17 00:00:00 2001 From: Ryan <49769153+TurnOfACard@users.noreply.github.com> Date: Thu, 1 Sep 2022 15:40:44 +1000 Subject: [PATCH] Added documentation on parquet compatibility under `TimeUnit`. (#1238) --- src/io/parquet/write/mod.rs | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/io/parquet/write/mod.rs b/src/io/parquet/write/mod.rs index 0abc6330a85..0b692e9835f 100644 --- a/src/io/parquet/write/mod.rs +++ b/src/io/parquet/write/mod.rs @@ -1,4 +1,17 @@ //! APIs to write to Parquet format. +//! +//! # Arrow/Parquet Interoperability +//! As of [parquet-format v2.9](https://github.com/apache/parquet-format/blob/master/LogicalTypes.md) +//! there are Arrow [DataTypes](crate::datatypes::DataType) which do not have a parquet +//! representation. These include but are not limited to: +//! * `DataType::Timestamp(TimeUnit::Second, _)` +//! * `DataType::Int64` +//! * `DataType::Duration` +//! * `DataType::Date64` +//! * `DataType::Time32(TimeUnit::Second)` +//! +//! The use of these arrow types will result in no logical type being stored within a parquet file. + mod binary; mod boolean; mod dictionary;