Skip to content

Commit

Permalink
Add more details according to comments
Browse files Browse the repository at this point in the history
  • Loading branch information
liurenjie1024 committed Dec 25, 2023
1 parent 9b70ff9 commit c286c09
Showing 1 changed file with 49 additions and 6 deletions.
55 changes: 49 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,67 @@ Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/).
| GCS | Not Started |
| HDFS | Not Started |

Our `FileIO` is powered by [Apache OpenDAL](https://github.com/apache/incubator-opendal), so it would be quite easy to
expand to other service.

### Table API

* Table reader, including planning, reading into arrow record batch, etc.
* Table writer, including data writer, equality deletion writer, position deletion writer, etc.
* Transaction api, including schema evolution, update table, etc.
#### Reader

| Feature | Status |
|------------------------------------------------------------|-------------|
| File based task planning | In progress |
| Size based task planning | Not started |
| Filter pushdown(manifest evaluation, partition prunning) | Not started |
| Apply deletions, including equality and position deletions | Not started |
| Read into arrow record batch | Not started |
| Parquet file support | Not started |
| Orc file support | Not started |

#### Writer

| Feature | Status |
|--------------------------|-------------|
| Data writer | Not started |
| Equality deletion writer | Not started |
| Position deletion writer | Not started |
| Partitioned writer | Not started |
| Upsert writer | Not started |
| Parquet file support | Not started |
| Orc file support | Not started |

#### Transaction

| Feature | Status |
|-----------------------|-------------|
| Schema evolution | Not started |
| Update partition spec | Not started |
| Update properties | Not started |
| Replace sort order | Not started |
| Update location | Not started |
| Append files | Not started |
| Rewrite files | Not started |
| Rewrite manifests | Not started |
| Overwrite files | Not started |
| Row level updates | Not started |
| Replace partitions | Not started |
| Snapshot management | Not started |

### Integrations

We will add integrations with other rust based data systems, such as polars, datafusion, etc.

## Contribute

Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are some ways to go.
Iceberg is an active open-source project. We are always open to people who want to use it or contribute to it. Here are
some ways to go.

- Start with [Contributing Guide](CONTRIBUTING.md).
- Submit [Issues](https://github.com/apache/iceberg-rust/issues/new) for bug report or feature requests.
- Discuss at [dev mailing list](mailto:[email protected]) ([subscribe](mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe)) / [unsubscribe](mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe)) / [archives](https://lists.apache.org/[email protected]))
- Talk to community directly at [Slack #rust channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A).
- Discuss
at [dev mailing list](mailto:[email protected]) ([subscribe](mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe)) / [unsubscribe](mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe)) / [archives](https://lists.apache.org/[email protected]))
- Talk to community directly
at [Slack #rust channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A).

## License

Expand Down

0 comments on commit c286c09

Please sign in to comment.