Skip to content

Commit b2416ff

Browse files
authored
Update parquet crate readme (#1192)
* Update parquet crate readme * prettier
1 parent 96a9a54 commit b2416ff

File tree

1 file changed

+5
-17
lines changed

1 file changed

+5
-17
lines changed

parquet/README.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,29 +40,17 @@ while let Some(record) = iter.next() {
4040
}
4141
```
4242

43-
See [crate documentation](https://docs.rs/crate/parquet) on available API.
43+
For an example of reading to Arrow arrays, please see [here](https://docs.rs/parquet/latest/parquet/arrow/index.html)
44+
45+
See [crate documentation](https://docs.rs/parquet/latest/parquet/) for the full API.
4446

4547
## Rust Version Compatbility
4648

4749
This crate is tested with the latest stable version of Rust. We do not currrently test against other, older versions of the Rust compiler.
4850

49-
## Upgrading from versions prior to 4.0
50-
51-
If you are upgrading from version 3.0 or previous of this crate, you
52-
likely need to change your code to use [`ConvertedType`] rather than
53-
[`LogicalType`] to preserve existing behaviour in your code.
54-
55-
Version 2.4.0 of the Parquet format introduced a `LogicalType` to replace the existing `ConvertedType`.
56-
This crate used `parquet::basic::LogicalType` to map to the `ConvertedType`, but this has been renamed to `parquet::basic::ConvertedType` from version 4.0 of this crate.
57-
58-
The `ConvertedType` is deprecated in the format, but is still written
59-
to preserve backward compatibility.
60-
It is preferred that `LogicalType` is used, as it supports nanosecond
61-
precision timestamps without using the deprecated `Int96` Parquet type.
62-
6351
## Supported Parquet Version
6452

65-
- Parquet-format 2.6.0
53+
- Parquet-format 4.0.0
6654

6755
To update Parquet format to a newer version, check if [parquet-format](https://github.com/sunchao/parquet-format-rs)
6856
version is available. Then simply update version of `parquet-format` crate in Cargo.toml.
@@ -81,7 +69,7 @@ version is available. Then simply update version of `parquet-format` crate in Ca
8169
- [ ] Row record writer
8270
- [x] Arrow record writer
8371
- [ ] Predicate pushdown
84-
- [x] Parquet format 2.6.0 support
72+
- [x] Parquet format 4.0.0 support
8573

8674
## License
8775

0 commit comments

Comments
 (0)