kevinjqliu commented on code in PR #1459: URL: https://github.com/apache/iceberg-rust/pull/1459#discussion_r2160421219
########## crates/catalog/sql/README.md: ########## @@ -0,0 +1,39 @@ +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. +--> + +# Apache Iceberg SQL Catalog Official Native Rust Implementation + +[](https://crates.io/crates/iceberg-catalog-sql) +[](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 = "X.Y.Z", features = ["runtime-tokio", "sqlite"] } Review Comment: ```suggestion sqlx = { version = "A.B.C", features = ["runtime-tokio", "sqlite"] } ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
