From 514014d08b47ee6eb7f5233042e946c93cb4d171 Mon Sep 17 00:00:00 2001 From: Kenny Daniel Date: Tue, 13 Feb 2024 10:50:36 -0800 Subject: [PATCH] Readme section on supported parquet files --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index cf3fc66..9366d74 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,29 @@ const metadata = parquetMetadata(arrayBuffer) To parse parquet files from a user drag-and-drop action, see example in [index.html](index.html). +## Supported Parquet Files + +The parquet format supports a number of different compression and encoding types. +Hyparquet does not support 100% of all parquet files, and probably never will, since supporting all possible compression types will increase the size of the library, and are rarely used in practice. + +Compression: + - [X] Uncompressed + - [X] Snappy + - [ ] GZip + - [ ] LZO + - [ ] Brotli + - [ ] LZ4 + - [ ] ZSTD + - [ ] LZ4_RAW + +Page Type: + - [X] Data Page + - [ ] Index Page + - [X] Dictionary Page + - [ ] Data Page V2 + +Contributions are welcome! + ## References - https://github.com/apache/parquet-format