From 14e839e4482c02608f0f6969bae91a4a2d88b11d Mon Sep 17 00:00:00 2001 From: Gidon Gershinsky Date: Sun, 20 Dec 2020 13:24:42 +0200 Subject: [PATCH] ARROW-10941: [Doc][C++] Document supported Parquet encryption features --- docs/source/cpp/parquet.rst | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/source/cpp/parquet.rst b/docs/source/cpp/parquet.rst index 8aeee1f747b..a81fadb8eda 100644 --- a/docs/source/cpp/parquet.rst +++ b/docs/source/cpp/parquet.rst @@ -27,6 +27,10 @@ Reading and writing Parquet files .. seealso:: :ref:`Parquet reader and writer API reference `. +.. sidebar:: Contents + + .. contents:: :local: + The `Parquet format `__ is a space-efficient columnar storage format for complex data. The Parquet C++ implementation is part of the Apache Arrow project and benefits @@ -244,7 +248,22 @@ Limitations Writing or reading back FixedSizedList data with null entries is not supported. -.. TODO: document supported encryption features +Encryption +---------- + +Parquet C++ implements all features specified in the +`encryption specification `__, +except for encryption of column index and bloom filter modules. + +More specifically, Parquet C++ supports: + +* AES_GCM_V1 and AES_GCM_CTR_V1 encryption algorithms. +* AAD suffix for Footer, ColumnMetaData, Data Page, Dictionary Page, + Data PageHeader, Dictionary PageHeader module types. Other module types + (ColumnIndex, OffsetIndex, BloomFilter Header, BloomFilter Bitset) are not + supported. +* EncryptionWithFooterKey and EncryptionWithColumnKey modes. +* Encrypted Footer and Plaintext Footer modes. Reading Parquet files