[docs] Add Rust client documentation#2462
Conversation
leekeiabstraction
left a comment
There was a problem hiding this comment.
TY for the PR. Left some comments. PTAL!
website/docs/apis/rust-client.md
Outdated
|
|
||
| ```toml | ||
| [dependencies] | ||
| fluss-client = "0.6.0" # Replace with the latest version |
There was a problem hiding this comment.
Can you confirm if this is currently available publicly?
website/docs/apis/rust-client.md
Outdated
| conf.set_string("client.security.protocol", "sasl"); | ||
| conf.set_string("client.security.sasl.mechanism", "PLAIN"); | ||
| conf.set_string("client.security.sasl.username", "alice"); | ||
| conf.set_string("client.security.sasl.password", "alice-secret"); |
There was a problem hiding this comment.
Are these currently honoured?
|
Hi @leekeiabstraction I've updated the Rust documentation. Since the crate is not yet public on crates.io, I changed the installation section to show how to use it as a Git dependency. I also reordered the sections so Admin API comes first and added the requested initialization comments. PTAL! |
|
Hello Prajwal, There has been some recent changes to rust API. Are you able to update this PR accordingly? For your reference, this PR apache/fluss-rust#242 is a more comprehensive rust client doc. Keep your PR structure as is (light weight intro) but also add a link to the more comprehensive doc on rust client side |
|
Hi @leekeiabstraction, I’ve updated the Rust documentation to align with the latest changes PTAL! |
leekeiabstraction
left a comment
There was a problem hiding this comment.
Thank you @Prajwal-banakar for working on this. I'm thinking that we should do the following:
- Move the content of this PR to fluss-rust
- Change this pr to point to fluss-rust website.
This approach will ensure that rust/cpp/python docs stay near to client source and is discoverable from main site.
|
Hi @leekeiabstraction , I've slimmed down the page to a lightweight intro with an installation snippet and a quick example, linking to https://clients.fluss.apache.org/user-guide/rust/installation for the full reference. The link is currently broken since the fluss-rust site hasn't been deployed yet, but it will resolve once the site goes live. |
|
Hi @leekeiabstraction This PR has been open since January and I've addressed all the feedback. Could you please take a look when you get a chance? I don't want to lose track of it. PTAL! And same to this pr also : #2461 |
|
Ack @Prajwal-banakar Thank you, I have been holding this off because rust side docs weren't ready. We have finally got the site setup with help from apache infra today: https://issues.apache.org/jira/browse/INFRA-27705 I'm currently away but will be able to verify, test & merge on Sunday. |
|
TY for the PR Prajwal, I've added more links on the page and removed |
Purpose
Linked issue: close #2446
The purpose of this change is to provide comprehensive documentation for the Fluss Rust Client. This helps Rust developers understand how to interact with the Fluss cluster, manage resources, and perform high-performance data operations.
Brief change log
This pull request introduces the following changes:
New Documentation: Created website/docs/apis/rust-client.md based on the existing Java client structure.
Rust Snippets: Added asynchronous code examples for initialization using Tokio, Admin API usage, and Table API operations (Writers/Scanners/Lookups).
Type Mapping: Included a dedicated section mapping Fluss internal types to native Rust types.
Sidebar Hierarchy: Configured the sidebar to display the Rust Client immediately following the Python Client.
Build Metadata: Updated website/package-lock.json to ensure consistency in the website build environment.
Tests
Manual UI Verification: The documentation was built locally using the Docusaurus development server.
Rendering Check: Confirmed that all Rust syntax highlighting, tables, and sidebar navigation items display correctly at localhost:3000.
After changes

API and Format
This change is documentation-only and does not affect the API or storage format of the Fluss server or clients.
Documentation
This PR introduces a new documentation page for the Fluss Rust Client.