Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions website/docs/apis/rust-client.md
Original file line number Diff line number Diff line change
@@ -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)**.