Skip to content

Commit fa5f2ed

Browse files
atcolAlexliurenjie1024
authored
docs: tidying; update version refs; describe various catalogues (#1616)
## Which issue does this PR close? No issue. I thought I'd improve the docs a bit. ## What changes are included in this PR? Only changes to the website (mdbook). ## Are these changes tested? Yes all pages render correctly. --------- Co-authored-by: Alex <atc@localhost> Co-authored-by: Renjie Liu <liurenjie2008@gmail.com>
1 parent d241107 commit fa5f2ed

File tree

4 files changed

+36
-6
lines changed

4 files changed

+36
-6
lines changed

crates/iceberg/src/catalog/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ pub trait CatalogBuilder: Default + Debug + Send + Sync {
125125
/// NamespaceIdent represents the identifier of a namespace in the catalog.
126126
///
127127
/// The namespace identifier is a list of strings, where each string is a
128-
/// component of the namespace. It's catalog implementer's responsibility to
128+
/// component of the namespace. It's the catalog implementer's responsibility to
129129
/// handle the namespace identifier correctly.
130130
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
131131
pub struct NamespaceIdent(Vec<String>);

website/src/api.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,22 @@
2424
* Create and list namespaces.
2525
* Create, load, and drop tables
2626

27-
Currently only rest catalog has been implemented, and other catalogs are under active development. Here is an
28-
example of how to create a `RestCatalog`:
27+
There is support for the following catalogs:
28+
29+
| Catalog | Description |
30+
|---------|------------|
31+
| `Rest` | the Iceberg REST catalog |
32+
| `Glue` | the AWS Glue Data Catalog |
33+
| `Memory` | a memory-based Catalog |
34+
| `HMS` | Apache Iceberg HiveMetaStore catalog |
35+
| `S3Tables` | AWS S3 Tables |
36+
| `SQL` | SQL-based catalog |
37+
38+
Not all catalog implementations are complete.
39+
40+
## `RestCatalog`
41+
42+
Here is an example of how to create a `RestCatalog`:
2943

3044
```rust,no_run,noplayground
3145
{{#rustdoc_include ../../crates/examples/src/rest_catalog_namespace.rs:create_catalog}}

website/src/install.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,14 @@ Cargo 1.75.0 or later is required to build.
2626
Add `iceberg` and `iceberg-catalog-rest` into `Cargo.toml` dependencies:
2727

2828
```toml
29-
iceberg = "0.2.0"
30-
iceberg-catalog-rest = "0.2.0"
29+
iceberg = "0.6.0"
30+
iceberg-catalog-rest = "0.6.0"
31+
```
32+
33+
using `cargo add`:
34+
35+
```bash
36+
$ cargo add iceberg iceberg-catalog-rest
3137
```
3238

3339
iceberg is under active development, you may want to use the git version instead:

website/src/introduction.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,14 @@
1919

2020
# Iceberg Rust
2121

22-
Iceberg Rust is a rust implementation for accessing iceberg tables.
22+
`iceberg-rust` is a Rust implementation for managing Apache Iceberg tables.
23+
24+
## What is Apache Iceberg?
25+
26+
[Apache Iceberg](https://iceberg.apache.org) is a modern, high-performance open table format
27+
for huge analytic datasets that brings SQL-like tables to processing engines including Spark, Trino, PrestoDB, Flink, Hive and Impala.
28+
29+
Iceberg provides a metadata layer that sits on top of formats like Parquet
30+
and ORC, ensuring data is organized, accessible, and safe to work with at scale. It introduces features long
31+
expected in databases such as transactional consistency, schema evolution, and time travel into environments
32+
where files are stored directly on systems like Amazon S3.

0 commit comments

Comments
 (0)