-
Notifications
You must be signed in to change notification settings - Fork 750
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refresh parquet readme / contributing guide #1252
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the supported format is already listed in the features section -- moved this content to contributing guide |
||
|
||
- 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) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. assumes #1154 is merged |
||
- [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 | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This example is row oriented -- I am working on a PR that has some more realistic examples (and will include them on the docs.rs landing page)