diff --git a/crates/iceberg/src/catalog/mod.rs b/crates/iceberg/src/catalog/mod.rs index a468edc475..26d65d1c84 100644 --- a/crates/iceberg/src/catalog/mod.rs +++ b/crates/iceberg/src/catalog/mod.rs @@ -125,7 +125,7 @@ pub trait CatalogBuilder: Default + Debug + Send + Sync { /// NamespaceIdent represents the identifier of a namespace in the catalog. /// /// The namespace identifier is a list of strings, where each string is a -/// component of the namespace. It's catalog implementer's responsibility to +/// component of the namespace. It's the catalog implementer's responsibility to /// handle the namespace identifier correctly. #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)] pub struct NamespaceIdent(Vec); diff --git a/website/src/api.md b/website/src/api.md index eaf81ee661..27a68cbdcf 100644 --- a/website/src/api.md +++ b/website/src/api.md @@ -24,8 +24,22 @@ * Create and list namespaces. * Create, load, and drop tables -Currently only rest catalog has been implemented, and other catalogs are under active development. Here is an -example of how to create a `RestCatalog`: +There is support for the following catalogs: + +| Catalog | Description | +|---------|------------| +| `Rest` | the Iceberg REST catalog | +| `Glue` | the AWS Glue Data Catalog | +| `Memory` | a memory-based Catalog | +| `HMS` | Apache Iceberg HiveMetaStore catalog | +| `S3Tables` | AWS S3 Tables | +| `SQL` | SQL-based catalog | + +Not all catalog implementations are complete. + +## `RestCatalog` + +Here is an example of how to create a `RestCatalog`: ```rust,no_run,noplayground {{#rustdoc_include ../../crates/examples/src/rest_catalog_namespace.rs:create_catalog}} diff --git a/website/src/install.md b/website/src/install.md index bcda751a3f..3528bd74fb 100644 --- a/website/src/install.md +++ b/website/src/install.md @@ -26,8 +26,14 @@ Cargo 1.75.0 or later is required to build. Add `iceberg` and `iceberg-catalog-rest` into `Cargo.toml` dependencies: ```toml -iceberg = "0.2.0" -iceberg-catalog-rest = "0.2.0" +iceberg = "0.6.0" +iceberg-catalog-rest = "0.6.0" +``` + +using `cargo add`: + +```bash +$ cargo add iceberg iceberg-catalog-rest ``` iceberg is under active development, you may want to use the git version instead: diff --git a/website/src/introduction.md b/website/src/introduction.md index 260ec690ed..769e50857c 100644 --- a/website/src/introduction.md +++ b/website/src/introduction.md @@ -19,4 +19,14 @@ # Iceberg Rust -Iceberg Rust is a rust implementation for accessing iceberg tables. +`iceberg-rust` is a Rust implementation for managing Apache Iceberg tables. + +## What is Apache Iceberg? + +[Apache Iceberg](https://iceberg.apache.org) is a modern, high-performance open table format +for huge analytic datasets that brings SQL-like tables to processing engines including Spark, Trino, PrestoDB, Flink, Hive and Impala. + +Iceberg provides a metadata layer that sits on top of formats like Parquet +and ORC, ensuring data is organized, accessible, and safe to work with at scale. It introduces features long +expected in databases such as transactional consistency, schema evolution, and time travel into environments +where files are stored directly on systems like Amazon S3.