From 338016dca7bffada1802c65f1713239e48a3ef78 Mon Sep 17 00:00:00 2001 From: Kyteware Date: Fri, 20 Jun 2025 16:06:05 -0700 Subject: [PATCH 1/5] doc: readme for sql catalog with same format as other catalog readmes --- crates/catalog/sql/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 crates/catalog/sql/README.md diff --git a/crates/catalog/sql/README.md b/crates/catalog/sql/README.md new file mode 100644 index 000000000..093adb938 --- /dev/null +++ b/crates/catalog/sql/README.md @@ -0,0 +1,27 @@ + + +# Apache Iceberg SQL Catalog Official Native Rust Implementation + +[![crates.io](https://img.shields.io/crates/v/iceberg.svg)](https://crates.io/crates/iceberg-catalog-sql) +[![docs.rs](https://img.shields.io/docsrs/iceberg.svg)](https://docs.rs/iceberg/latest/iceberg-catalog-sql/) + +This crate contains the official Native Rust implementation of Apache Iceberg Rest Catalog. + +See the [API documentation](https://docs.rs/iceberg-catalog-sql/latest) for examples and the full API. From e74be807cc5ac8bdd60dbb5273f8287965350ff5 Mon Sep 17 00:00:00 2001 From: Kyteware Date: Fri, 20 Jun 2025 16:10:46 -0700 Subject: [PATCH 2/5] doc: add sections to sql catalog about sqlx database support --- crates/catalog/sql/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/crates/catalog/sql/README.md b/crates/catalog/sql/README.md index 093adb938..a89b69154 100644 --- a/crates/catalog/sql/README.md +++ b/crates/catalog/sql/README.md @@ -25,3 +25,15 @@ This crate contains the official Native Rust implementation of Apache Iceberg Rest Catalog. See the [API documentation](https://docs.rs/iceberg-catalog-sql/latest) for examples and the full API. + +## Database support + +For additional database support (such as for `sqlite` databases), include the `sqlx` dependancy in your crate with the needed features. + +For example, to include support for `sqlite` databases, these should both be included in your `Cargo.toml` + +```toml +[dependencies] +iceberg-catalog-sql = "X.Y.Z" +sqlx = { version = "X.Y.Z", features = ["runtime-tokio", "sqlite"] } +``` From d8985870adebef453333174f12dae81fe8ae190b Mon Sep 17 00:00:00 2001 From: Kyteware Date: Fri, 20 Jun 2025 17:10:21 -0700 Subject: [PATCH 3/5] doc: fix misnomer in sql catalog readme --- crates/catalog/sql/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/catalog/sql/README.md b/crates/catalog/sql/README.md index a89b69154..7c6ea8a95 100644 --- a/crates/catalog/sql/README.md +++ b/crates/catalog/sql/README.md @@ -22,7 +22,7 @@ [![crates.io](https://img.shields.io/crates/v/iceberg.svg)](https://crates.io/crates/iceberg-catalog-sql) [![docs.rs](https://img.shields.io/docsrs/iceberg.svg)](https://docs.rs/iceberg/latest/iceberg-catalog-sql/) -This crate contains the official Native Rust implementation of Apache Iceberg Rest Catalog. +This crate contains the official Native Rust implementation of Apache Iceberg SQL Catalog. See the [API documentation](https://docs.rs/iceberg-catalog-sql/latest) for examples and the full API. From 92b2c0068b872579c7b4eff6f74f55dd815afb5e Mon Sep 17 00:00:00 2001 From: Kyteware Date: Fri, 20 Jun 2025 17:13:08 -0700 Subject: [PATCH 4/5] doc: fix typo in readme --- crates/catalog/sql/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/catalog/sql/README.md b/crates/catalog/sql/README.md index 7c6ea8a95..8575c7d2f 100644 --- a/crates/catalog/sql/README.md +++ b/crates/catalog/sql/README.md @@ -28,7 +28,7 @@ See the [API documentation](https://docs.rs/iceberg-catalog-sql/latest) for exam ## Database support -For additional database support (such as for `sqlite` databases), include the `sqlx` dependancy in your crate with the needed features. +For additional database support (such as for `sqlite` databases), include the `sqlx` dependency in your crate with the needed features. For example, to include support for `sqlite` databases, these should both be included in your `Cargo.toml` From bc15f684cb3eb78142d07a032bc6deb1c3f435b8 Mon Sep 17 00:00:00 2001 From: Ryan <88643996+kyteware@users.noreply.github.com> Date: Wed, 25 Jun 2025 18:13:23 -0700 Subject: [PATCH 5/5] doc: make version variables differ to avoid confusion Co-authored-by: Kevin Liu --- crates/catalog/sql/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/catalog/sql/README.md b/crates/catalog/sql/README.md index 8575c7d2f..6725ef02f 100644 --- a/crates/catalog/sql/README.md +++ b/crates/catalog/sql/README.md @@ -35,5 +35,5 @@ For example, to include support for `sqlite` databases, these should both be inc ```toml [dependencies] iceberg-catalog-sql = "X.Y.Z" -sqlx = { version = "X.Y.Z", features = ["runtime-tokio", "sqlite"] } +sqlx = { version = "A.B.C", features = ["runtime-tokio", "sqlite"] } ```