[docs] Add Rust client documentation #2462
Conversation
|
Hi @polyzos, this PR failed again due to a timeout in the Flink engine tests (Flink22ChangelogVirtualTableITCase). This appears to be another flaky test unrelated to the Rust documentation changes. Could you please trigger a re-run when the CI environment is stable? and also check the PR |
leekeiabstraction
left a comment
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! |
2 participants
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.