Readme section on supported parquet files

This commit is contained in:
Kenny Daniel 2024-02-13 10:50:36 -08:00
parent 88121409bf
commit 514014d08b
No known key found for this signature in database
GPG Key ID: 90AB653A8CAD7E45

@ -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