Skip to content

docs: refresh Rust client docs for the official apache/iotdb-client-rust SDK#1188

Open
CritasWang wants to merge 1 commit into
mainfrom
docs/rust-client-sdk
Open

docs: refresh Rust client docs for the official apache/iotdb-client-rust SDK#1188
CritasWang wants to merge 1 commit into
mainfrom
docs/rust-client-sdk

Conversation

@CritasWang

Copy link
Copy Markdown
Contributor

Summary

The Rust client has been accepted by vote and now lives at apache/iotdb-client-rust. This PR brings the website docs in line with the official SDK.

  • Rewrite the tree-model Rust API page (latest + Master/Tree, en + zh). The old page documented hand-generating Thrift stubs from the server's pom.xml — with an official SDK that guidance is obsolete. The new page covers installation (crates.io name iotdb-client-rust, import name iotdb_client), a tree-model quick start, SessionPool, and TLS / RPC-compression configuration.
  • Add the table-model Rust API page (latest-Table + Master/Table, en + zh), following the _apache.md naming used by the other language clients in those trees: TableSession builder, tablet writes with ColumnCategory, TableSessionPool.
  • Sidebars: added the Rust entry to the V2.0.x Table sidebars (en + zh). The Tree sidebars already listed Programming-Rust-Native-API.

Code samples are taken from the SDK's README/examples, which run as e2e smoke tests in the client repo's CI against IoTDB 2.0.6 and 2.0.10.

Notes

  • The SDK is not yet published to crates.io (release vote pending); the docs show the git-dependency fallback until then.
  • Older version trees (V1.2.x/V1.3.x/dev-1.3) intentionally keep the legacy Thrift-stub instructions, since the SDK targets IoTDB 2.x.

🤖 Generated with Claude Code

…ust SDK

- Rewrite the tree-model Rust API page (latest + Master/Tree, en + zh):
  the old page documented hand-generating Thrift stubs; it now covers the
  official SDK (installation, quick start, session pool, TLS/compression).
- Add the table-model Rust API page (latest-Table + Master/Table, en + zh).
- Add the Rust entry to the V2.0.x Table sidebars (en + zh); the Tree
  sidebars already had it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant