This is an automated email from the ASF dual-hosted git repository.
leekei pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fluss.git
The following commit(s) were added to refs/heads/main by this push:
new ee03ba7cf [docs] Add links to Rust client documentation (#2462)
ee03ba7cf is described below
commit ee03ba7cf475511cc2aff46b9c914eaca9efbddf
Author: Prajwal banakar <[email protected]>
AuthorDate: Mon Mar 23 01:43:13 2026 +0530
[docs] Add links to Rust client documentation (#2462)
* add Rust client documentation
* address Rust reviewer feedback on installation and logical flow
* align rust client sidebar position and clarify installation
* align rust client with recent changes
* pointing to fluss-rust website.
* Admin API, Table API link and Examples links.
* Remove package-lock.json
---------
Co-authored-by: Keith Lee <[email protected]>
---
website/docs/apis/rust-client.md | 53 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 53 insertions(+)
diff --git a/website/docs/apis/rust-client.md b/website/docs/apis/rust-client.md
new file mode 100644
index 000000000..910510c6e
--- /dev/null
+++ b/website/docs/apis/rust-client.md
@@ -0,0 +1,53 @@
+---
+title: "Rust Client"
+sidebar_position: 4
+---
+
+# Fluss Rust Client
+
+The Fluss Rust Client is a high-performance, asynchronous library powered by
the
+[Tokio](https://tokio.rs/) runtime. It provides a native interface for
interacting
+with Fluss clusters with minimal overhead.
+
+The client provides two main APIs:
+
+- **[Admin
API](https://clients.fluss.apache.org/user-guide/rust/api-reference#flussadmin)**:
For managing databases, tables, and partitions.
+- **[Table
API](https://clients.fluss.apache.org/user-guide/rust/api-reference/#flusstablea)**:
For reading and writing to Log and Primary Key tables
+
+## Installation
+
+The Fluss Rust client is published to
[crates.io](https://crates.io/crates/fluss-rs)
+as `fluss-rs`. The crate's library name is `fluss`, so you import it with `use
fluss::...`.
+
+Add the following to your `Cargo.toml`:
+```toml
+[dependencies]
+fluss-rs = "0.1"
+tokio = { version = "1", features = ["full"] }
+```
+
+## Quick Example
+```rust
+use fluss::client::FlussConnection;
+use fluss::config::Config;
+use fluss::error::Result;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+ let mut config = Config::default();
+ config.bootstrap_servers = "127.0.0.1:9123".to_string();
+
+ let conn = FlussConnection::new(config).await?;
+ let admin = conn.get_admin().await?;
+
+ Ok(())
+}
+```
+
+For more examples, see [Fluss Rust Client
documentation](https://clients.fluss.apache.org/user-guide/rust/example/).
+
+## Full Documentation
+
+For the complete Rust client reference including all configuration options,
+API methods, data types, error handling, and worked examples — see the
+**[Fluss Rust Client
documentation](https://clients.fluss.apache.org/user-guide/rust/installation)**.
\ No newline at end of file
