You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by al...@apache.org on 2022/02/02 11:16:09 UTC
[arrow-rs] branch master updated: Refresh readme / contributing guide (#1252)
This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new f80f1be Refresh readme / contributing guide (#1252)
f80f1be is described below
commit f80f1bed2908da12a2b192832178d42a3c7556d1
Author: Andrew Lamb <an...@nerdnetworks.org>
AuthorDate: Wed Feb 2 06:16:05 2022 -0500
Refresh readme / contributing guide (#1252)
---
parquet/CONTRIBUTING.md | 5 +++++
parquet/README.md | 30 +++---------------------------
2 files changed, 8 insertions(+), 27 deletions(-)
diff --git a/parquet/CONTRIBUTING.md b/parquet/CONTRIBUTING.md
index 834b6af..77e9f41 100644
--- a/parquet/CONTRIBUTING.md
+++ b/parquet/CONTRIBUTING.md
@@ -59,3 +59,8 @@ Run `cargo bench` for benchmarks.
To build documentation, run `cargo doc --no-deps`.
To compile and view in the browser, run `cargo doc --no-deps --open`.
+
+## Update Supported Parquet Version
+
+To update Parquet format to a newer version, check if [parquet-format](https://github.com/sunchao/parquet-format-rs)
+version is available. Then simply update version of `parquet-format` crate in Cargo.toml.
diff --git a/parquet/README.md b/parquet/README.md
index 74e6431..ed8b551 100644
--- a/parquet/README.md
+++ b/parquet/README.md
@@ -23,38 +23,12 @@
This crate contains the official Native Rust implementation of [Apache Parquet](https://parquet.apache.org/), which is part of the [Apache Arrow](https://arrow.apache.org/) project.
-## Example
-
-Example usage of reading data:
-
-```rust
-use std::fs::File;
-use std::path::Path;
-use parquet::file::reader::{FileReader, SerializedFileReader};
-
-let file = File::open(&Path::new("/path/to/file")).unwrap();
-let reader = SerializedFileReader::new(file).unwrap();
-let mut iter = reader.get_row_iter(None).unwrap();
-while let Some(record) = iter.next() {
- println!("{}", record);
-}
-```
-
-For an example of reading to Arrow arrays, please see [here](https://docs.rs/parquet/latest/parquet/arrow/index.html)
-
-See [crate documentation](https://docs.rs/parquet/latest/parquet/) for the full API.
+See [crate documentation](https://docs.rs/parquet/latest/parquet/) for examples and the full API.
## Rust Version Compatbility
This crate is tested with the latest stable version of Rust. We do not currrently test against other, older versions of the Rust compiler.
-## Supported Parquet Version
-
-- Parquet-format 4.0.0
-
-To update Parquet format to a newer version, check if [parquet-format](https://github.com/sunchao/parquet-format-rs)
-version is available. Then simply update version of `parquet-format` crate in Cargo.toml.
-
## Features
- [x] All encodings supported
@@ -63,11 +37,13 @@ version is available. Then simply update version of `parquet-format` crate in Ca
- [x] Primitive column value readers
- [x] Row record reader
- [x] Arrow record reader
+ - [x] Async support (to Arrow)
- [x] Statistics support
- [x] Write support
- [x] Primitive column value writers
- [ ] Row record writer
- [x] Arrow record writer
+ - [ ] Async support
- [ ] Predicate pushdown
- [x] Parquet format 4.0.0 support