diff --git a/crates/catalog/sql/README.md b/crates/catalog/sql/README.md new file mode 100644 index 000000000..6725ef02f --- /dev/null +++ b/crates/catalog/sql/README.md @@ -0,0 +1,39 @@ + + +# 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 SQL 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` 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` + +```toml +[dependencies] +iceberg-catalog-sql = "X.Y.Z" +sqlx = { version = "A.B.C", features = ["runtime-tokio", "sqlite"] } +```