luoyuxia commented on code in PR #415: URL: https://github.com/apache/fluss-rust/pull/415#discussion_r2881546858
########## crates/fluss/README.md: ########## @@ -1,25 +1,105 @@ -# Apache Fluss™ Rust Client (Incubating) +# Apache Fluss (Incubating) Official Rust Client -Rust client library for [Apache Fluss™](https://fluss.apache.org/). This crate provides the core client used by the fluss-rust workspace and by the Python and C++ bindings. +Official Rust client library for [Apache Fluss (Incubating)](https://fluss.apache.org/). -# Todo: move how to use to the first, and how to build to the last, https://github.com/apache/opendal/blob/main/core/README.md -# is a good reference +[](https://crates.io/crates/fluss-rs) +[](https://docs.rs/fluss-rs/) -## Requirements +## Usage -- Rust (see [rust-toolchain.toml](../../rust-toolchain.toml) at repo root) -- protobuf (for build) +The following example shows both **primary key (KV) tables** and **log tables** in one flow: connect, create a KV table (upsert + lookup), then create a log table (append + scan). -## Build +```rust Review Comment: Thanks for the thoughtful discussion! I think we can keep the current approach for now — the snippet is relatively small, and the API it demonstrates is stable enough that it's unlikely to go stale anytime soon. Let's leave it as-is and revisit if it becomes a real maintenance pain point down the road. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
