| <!-- |
| ~ Licensed to the Apache Software Foundation (ASF) under one |
| ~ or more contributor license agreements. See the NOTICE file |
| ~ distributed with this work for additional information |
| ~ regarding copyright ownership. The ASF licenses this file |
| ~ to you under the Apache License, Version 2.0 (the |
| ~ "License"); you may not use this file except in compliance |
| ~ with the License. You may obtain a copy of the License at |
| ~ |
| ~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~ |
| ~ Unless required by applicable law or agreed to in writing, |
| ~ software distributed under the License is distributed on an |
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~ KIND, either express or implied. See the License for the |
| ~ specific language governing permissions and limitations |
| ~ under the License. |
| --> |
| |
| # Apache Iceberg™ Rust |
| |
| |
| |
| Rust implementation of [Apache Iceberg™](https://iceberg.apache.org/). |
| |
| ## Components |
| |
| The Apache Iceberg Rust project is composed of the following components: |
| |
| | Name | Release | Docs | |
| |-------------------------------|--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| |
| | [iceberg] | [![iceberg image]][iceberg link] | [![docs release]][iceberg release docs] [![docs dev]][iceberg dev docs] | |
| | [iceberg-catalog-loader] | [![iceberg-catalog-loader image]][iceberg-catalog-loader link] | [![docs release]][iceberg-catalog-loader release docs] [![docs dev]][iceberg-catalog-loader dev docs] | |
| | [iceberg-catalog-glue] | [![iceberg-catalog-glue image]][iceberg-catalog-glue link] | [![docs release]][iceberg-catalog-glue release docs] [![docs dev]][iceberg-catalog-glue dev docs] | |
| | [iceberg-catalog-hms] | [![iceberg-catalog-hms image]][iceberg-catalog-hms link] | [![docs release]][iceberg-catalog-hms release docs] [![docs dev]][iceberg-catalog-hms dev docs] | |
| | [iceberg-catalog-rest] | [![iceberg-catalog-rest image]][iceberg-catalog-rest link] | [![docs release]][iceberg-catalog-rest release docs] [![docs dev]][iceberg-catalog-rest dev docs] | |
| | [iceberg-catalog-s3tables] | [![iceberg-catalog-s3tables image]][iceberg-catalog-s3tables link] | [![docs release]][iceberg-catalog-s3tables release docs] [![docs dev]][iceberg-catalog-s3tables dev docs] | |
| | [iceberg-catalog-sql] | [![iceberg-catalog-sql image]][iceberg-catalog-sql link] | [![docs release]][iceberg-catalog-sql release docs] [![docs dev]][iceberg-catalog-sql dev docs] | |
| | [iceberg-cache-moka] | [![iceberg-cache-moka image]][iceberg-cache-moka link] | [![docs release]][iceberg-cache-moka release docs] [![docs dev]][iceberg-cache-moka dev docs] | |
| | [iceberg-datafusion] | [![iceberg-datafusion image]][iceberg-datafusion link] | [![docs release]][iceberg-datafusion release docs] [![docs dev]][iceberg-datafusion dev docs] | |
| | [iceberg-storage-opendal] | [![iceberg-storage-opendal image]][iceberg-storage-opendal link] | [![docs release]][iceberg-storage-opendal release docs] [![docs dev]][iceberg-storage-opendal dev docs] | |
| |
| [docs release]: https://img.shields.io/badge/docs-release-blue |
| [docs dev]: https://img.shields.io/badge/docs-dev-blue |
| [iceberg]: crates/iceberg/README.md |
| [iceberg image]: https://img.shields.io/crates/v/iceberg.svg |
| [iceberg link]: https://crates.io/crates/iceberg |
| [iceberg release docs]: https://docs.rs/iceberg |
| [iceberg dev docs]: https://rust.iceberg.apache.org/api/iceberg/ |
| |
| [iceberg-datafusion]: crates/integrations/datafusion/README.md |
| [iceberg-datafusion image]: https://img.shields.io/crates/v/iceberg-datafusion.svg |
| [iceberg-datafusion link]: https://crates.io/crates/iceberg-datafusion |
| [iceberg-datafusion dev docs]: https://rust.iceberg.apache.org/api/iceberg_datafusion/ |
| [iceberg-datafusion release docs]: https://docs.rs/iceberg-datafusion |
| |
| [iceberg-catalog-glue]: crates/catalog/glue/README.md |
| [iceberg-catalog-glue image]: https://img.shields.io/crates/v/iceberg-catalog-glue.svg |
| [iceberg-catalog-glue link]: https://crates.io/crates/iceberg-catalog-glue |
| [iceberg-catalog-glue release docs]: https://docs.rs/iceberg-catalog-glue |
| [iceberg-catalog-glue dev docs]: https://rust.iceberg.apache.org/api/iceberg_catalog_glue/ |
| |
| [iceberg-catalog-hms]: crates/catalog/hms/README.md |
| [iceberg-catalog-hms image]: https://img.shields.io/crates/v/iceberg-catalog-hms.svg |
| [iceberg-catalog-hms link]: https://crates.io/crates/iceberg-catalog-hms |
| [iceberg-catalog-hms release docs]: https://docs.rs/iceberg-catalog-hms |
| [iceberg-catalog-hms dev docs]: https://rust.iceberg.apache.org/api/iceberg_catalog_hms/ |
| |
| [iceberg-catalog-rest]: crates/catalog/rest/README.md |
| [iceberg-catalog-rest image]: https://img.shields.io/crates/v/iceberg-catalog-rest.svg |
| [iceberg-catalog-rest link]: https://crates.io/crates/iceberg-catalog-rest |
| [iceberg-catalog-rest release docs]: https://docs.rs/iceberg-catalog-rest |
| [iceberg-catalog-rest dev docs]: https://rust.iceberg.apache.org/api/iceberg_catalog_rest/ |
| |
| [iceberg-catalog-sql]: crates/catalog/sql |
| [iceberg-catalog-sql image]: https://img.shields.io/crates/v/iceberg-catalog-sql.svg |
| [iceberg-catalog-sql link]: https://crates.io/crates/iceberg-catalog-sql |
| [iceberg-catalog-sql release docs]: https://docs.rs/iceberg-catalog-sql |
| [iceberg-catalog-sql dev docs]: https://rust.iceberg.apache.org/api/iceberg_catalog_sql/ |
| |
| [iceberg-catalog-s3tables]: crates/catalog/s3tables/README.md |
| [iceberg-catalog-s3tables image]: https://img.shields.io/crates/v/iceberg-catalog-s3tables.svg |
| [iceberg-catalog-s3tables link]: https://crates.io/crates/iceberg-catalog-s3tables |
| [iceberg-catalog-s3tables release docs]: https://docs.rs/iceberg-catalog-s3tables |
| [iceberg-catalog-s3tables dev docs]: https://rust.iceberg.apache.org/api/iceberg_catalog_s3tables/ |
| |
| [iceberg-storage-opendal]: crates/storage/opendal/README.md |
| [iceberg-storage-opendal image]: https://img.shields.io/crates/v/iceberg-storage-opendal.svg |
| [iceberg-storage-opendal link]: https://crates.io/crates/iceberg-storage-opendal |
| [iceberg-storage-opendal release docs]: https://docs.rs/iceberg-storage-opendal |
| [iceberg-storage-opendal dev docs]: https://rust.iceberg.apache.org/api/iceberg_storage_opendal/ |
| |
| [iceberg-catalog-loader]: crates/catalog/loader |
| [iceberg-catalog-loader image]: https://img.shields.io/crates/v/iceberg-catalog-loader.svg |
| [iceberg-catalog-loader link]: https://crates.io/crates/iceberg-catalog-loader |
| [iceberg-catalog-loader release docs]: https://docs.rs/iceberg-catalog-loader |
| [iceberg-catalog-loader dev docs]: https://rust.iceberg.apache.org/api/iceberg_catalog_loader/ |
| |
| [iceberg-cache-moka]: crates/integrations/cache-moka |
| [iceberg-cache-moka image]: https://img.shields.io/crates/v/iceberg-cache-moka.svg |
| [iceberg-cache-moka link]: https://crates.io/crates/iceberg-cache-moka |
| [iceberg-cache-moka release docs]: https://docs.rs/iceberg-cache-moka |
| [iceberg-cache-moka dev docs]: https://rust.iceberg.apache.org/api/iceberg_cache_moka/ |
| |
| ## Iceberg Rust Implementation Status |
| |
| The features that Iceberg Rust currently supports can be found [here](https://iceberg.apache.org/status/). |
| |
| ## Supported Rust Version |
| |
| Iceberg Rust is built and tested with stable rust, and will keep a rolling MSRV (minimum supported rust version). |
| At least three months from latest rust release is supported. MSRV is updated when we release iceberg-rust. |
| |
| Check the current MSRV on [crates.io](https://crates.io/crates/iceberg). |
| |
| ## Contribute |
| |
| Apache Iceberg is an active open-source project, governed under the Apache Software Foundation (ASF). Apache Iceberg Rust is always open to people who want to use or contribute to it. Here are some ways to get involved. |
| |
| - 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:dev@iceberg.apache.org) ([subscribe](<mailto:dev-subscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20subscribe)>) / [unsubscribe](<mailto:dev-unsubscribe@iceberg.apache.org?subject=(send%20this%20email%20to%20unsubscribe)>) / [archives](https://lists.apache.org/list.html?dev@iceberg.apache.org)) |
| - Talk to the community directly |
| at [Slack #rust channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A). |
| |
| The Apache Iceberg community is built on the principles described in the [Apache Way](https://www.apache.org/theapacheway/index.html) and all who engage with the community are expected to be respectful, open, come with the best interests of the community in mind, and abide by the Apache Foundation [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html). |
| ## Users |
| |
| - [Databend](https://github.com/datafuselabs/databend/): An open-source cloud data warehouse that serves as a cost-effective alternative to Snowflake. |
| - [Lakekeeper](https://github.com/lakekeeper/lakekeeper/): An Apache-licensed Iceberg REST Catalog with data access controls. |
| - [Moonlink](https://github.com/Mooncake-Labs/moonlink): A Rust library that enables sub-second mirroring (CDC) of Postgres tables into Iceberg. |
| - [RisingWave](https://github.com/risingwavelabs/risingwave): A Postgres-compatible SQL database designed for real-time event streaming data processing, analysis, and management. |
| - [Wrappers](https://github.com/supabase/wrappers): Postgres Foreign Data Wrapper development framework in Rust. |
| - [ETL](https://github.com/supabase/etl): Stream your Postgres data anywhere in real-time. |
| - [Apache DataFusion Comet](https://github.com/apache/datafusion-comet): High-performance accelerator for Apache Spark, built on top of the powerful Apache DataFusion query engine. |
| |
| ## License |
| |
| Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) |
