apache / apache/iotdb

[Bug] Rust Native API documentation out of date

Open
#16,532 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
6.4k
Forks
1.2k
Avg merge
1d 23h
Merged PRs (30d)
115

Description

### Search before asking

- [x] I searched in the [issues](https://github.com/apache/iotdb/issues) and found nothing similar.

### Version

2.0.x

### Describe the bug and provide the minimal reproduce step

The Rust Native API documentation does not include the correct pom.xml updates, generated files to copy and does not include any examples or generated client for parsing the responses from executed queries.

### What did you expect to see?

Correct documentation and additionally a small example similar to the Python Native API documentation.

### What did you see instead?

Outdated documentation.

### Anything else?

_No response_

### Are you willing to submit a PR?

- [ ] I'm willing to submit a PR!

Contributor guide

Open the contributing guide

Research direction

Compare the Rust Native API documentation with the Python Native API documentation, starting with the pom.xml updates and generated files mentioned in the issue. Document the required setup, copied generated files, and a small example or generated client for parsing executed-query responses; the documentation should match the current Rust API.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, rust
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.