Skip to content

docs: tidying; update version refs; describe various catalogues #1616

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

Merged
merged 12 commits into from
Aug 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crates/iceberg/src/catalog/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<String>);
Expand Down
18 changes: 16 additions & 2 deletions website/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
10 changes: 8 additions & 2 deletions website/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
12 changes: 11 additions & 1 deletion website/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading