Apache Parquet Official Native Rust Implementation
This crate contains the official Native Rust implementation of Apache Parquet, which is part of the Apache Arrow project.
See the API documentation for examples and the full API.
The API documentation for most recent, unreleased code is available here.
Rust Version Compatibility
This crate is tested with the latest stable version of Rust. We do not currently test against other, older versions of the Rust compiler.
Versioning / Releases
The arrow crate follows the SemVer standard defined by Cargo and works well within the Rust crate ecosystem.
However, for historical reasons, this crate uses versions with major numbers greater than 0.x
(e.g. 19.0.0
), unlike many other crates in the Rust ecosystem which spend extended time releasing versions 0.x
to signal planned ongoing API changes. Minor arrow releases contain only compatible changes, while major releases may contain breaking API changes.
Feature Flags
The parquet
crate provides the following features which may be enabled in your Cargo.toml
:
arrow
(default) - support for reading / writingarrow
arrays to / from parquetasync
- supportasync
APIs for reading parquetjson
- support for reading / writingjson
data to / from parquetbrotli
(default) - support for parquet usingbrotli
compressionflate2
(default) - support for parquet usinggzip
compressionlz4
(default) - support for parquet usinglz4
compressionzstd
(default) - support for parquet usingzstd
compressionsnap
(default) - support for parquet usingsnappy
compressioncli
- parquet CLI toolsexperimental
- Experimental APIs which may change, even between minor releases
Parquet Feature Status
- All encodings supported, except for BYTE_STREAM_SPLIT (#4102)
- All compression codecs supported
- Read support
- Primitive column value readers
- Row record reader
- Arrow record reader
- Async support (to Arrow)
- Statistics support
- Write support
- Primitive column value writers
- Row record writer
- Arrow record writer
- Async support
- Predicate pushdown
- Parquet format 4.0.0 support
Support for wasm32-unknown-unknown
target
It's possible to build parquet
for the wasm32-unknown-unknown
target, however not all the compression features are currently unsupported due to issues with the upstream crates. In particular, the zstd
and lz4
features may have compilation issues. See issue #180.
cargo build -p parquet --target wasm32-unknown-unknown --no-default-features --features cli,snap,flate2,brotli
License
Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0.