From c29e5b72d903feb35baafb4303e788f4b215c887 Mon Sep 17 00:00:00 2001 From: Adam Ji Date: Mon, 5 Jun 2023 15:02:00 +0800 Subject: [PATCH 1/5] docs: add assignments and seek offset --- docs/en/14-reference/03-connector/06-rust.mdx | 14 +++++++++++++- docs/zh/08-connector/26-rust.mdx | 14 +++++++++++++- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/en/14-reference/03-connector/06-rust.mdx b/docs/en/14-reference/03-connector/06-rust.mdx index 99c3d2c066..6af91d01ac 100644 --- a/docs/en/14-reference/03-connector/06-rust.mdx +++ b/docs/en/14-reference/03-connector/06-rust.mdx @@ -499,6 +499,18 @@ The TMQ is of [futures::Stream](https://docs.rs/futures/latest/futures/stream/in } ``` +Get assignments： + +```rust +let assignments = consumer.assignments().await.unwrap(); +``` + +Seek offset： + +```rust +consumer.offset_seek(topic, vgroup_id, offset).await; +``` + Unsubscribe: ```rust @@ -513,7 +525,7 @@ The following parameters can be configured for the TMQ DSN. Only `group.id` is m - `enable.auto.commit`: Automatically commits. This can be enabled when data consistency is not essential. - `auto.commit.interval.ms`: Interval for automatic commits. -For more information, see [GitHub sample file](https://github.com/taosdata/taos-connector-rust/blob/main/examples/subscribe.rs). +For more information, see [GitHub sample file](https://github.com/taosdata/TDengine/blob/3.0/docs/examples/rust/nativeexample/examples/subscribe_demo.rs). For information about other structure APIs, see the [Rust documentation](https://docs.rs/taos). diff --git a/docs/zh/08-connector/26-rust.mdx b/docs/zh/08-connector/26-rust.mdx index 41a429b026..095271e7da 100644 --- a/docs/zh/08-connector/26-rust.mdx +++ b/docs/zh/08-connector/26-rust.mdx @@ -502,6 +502,18 @@ TMQ 消息队列是一个 [futures::Stream](https://docs.rs/futures/latest/futur } ``` +获取消费进度： + +```rust +let assignments = consumer.assignments().await.unwrap(); +``` + +按照指定的进度消费： + +```rust +consumer.offset_seek(topic, vgroup_id, offset).await; +``` + 停止订阅： ```rust @@ -516,7 +528,7 @@ consumer.unsubscribe().await; - `enable.auto.commit`: 当设置为 `true` 时，将启用自动标记模式，当对数据一致性不敏感时，可以启用此方式。 - `auto.commit.interval.ms`: 自动标记的时间间隔。 -完整订阅示例参见 [GitHub 示例文件](https://github.com/taosdata/taos-connector-rust/blob/main/examples/subscribe.rs). +完整订阅示例参见 [GitHub 示例文件](https://github.com/taosdata/TDengine/blob/3.0/docs/examples/rust/nativeexample/examples/subscribe_demo.rs). 其他相关结构体 API 使用说明请移步 Rust 文档托管网页：。 From cc8a1b17be6dc3d49cd9d73d2373c95e0bd93838 Mon Sep 17 00:00:00 2001 From: Adam Ji Date: Mon, 5 Jun 2023 15:12:58 +0800 Subject: [PATCH 2/5] docs: add version requirements --- docs/zh/08-connector/26-rust.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/zh/08-connector/26-rust.mdx b/docs/zh/08-connector/26-rust.mdx index 095271e7da..9bb444d9e8 100644 --- a/docs/zh/08-connector/26-rust.mdx +++ b/docs/zh/08-connector/26-rust.mdx @@ -504,12 +504,17 @@ TMQ 消息队列是一个 [futures::Stream](https://docs.rs/futures/latest/futur 获取消费进度： +版本要求 connector-rust >= v0.8.8， TDengine >= 3.0.5.0 + ```rust let assignments = consumer.assignments().await.unwrap(); ``` 按照指定的进度消费： +版本要求 connector-rust >= v0.8.8， TDengine >= 3.0.5.0 + + ```rust consumer.offset_seek(topic, vgroup_id, offset).await; ``` From 581343037debd7e0a482aa3c287a1789a1882a1b Mon Sep 17 00:00:00 2001 From: Adam Ji Date: Mon, 5 Jun 2023 15:16:03 +0800 Subject: [PATCH 3/5] docs: add version --- docs/en/14-reference/03-connector/06-rust.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/en/14-reference/03-connector/06-rust.mdx b/docs/en/14-reference/03-connector/06-rust.mdx index 6af91d01ac..650d0d516d 100644 --- a/docs/en/14-reference/03-connector/06-rust.mdx +++ b/docs/en/14-reference/03-connector/06-rust.mdx @@ -501,12 +501,16 @@ The TMQ is of [futures::Stream](https://docs.rs/futures/latest/futures/stream/in Get assignments： +Version requirements connector-rust >= v0.8.8， TDengine >= 3.0.5.0 + ```rust let assignments = consumer.assignments().await.unwrap(); ``` Seek offset： +Version requirements connector-rust >= v0.8.8， TDengine >= 3.0.5.0 + ```rust consumer.offset_seek(topic, vgroup_id, offset).await; ``` From 4c5604d7e77328c794b1531ac7b8133cd98a6cdf Mon Sep 17 00:00:00 2001 From: Adam Ji Date: Mon, 5 Jun 2023 15:16:13 +0800 Subject: [PATCH 4/5] docs: fmt lines --- docs/zh/08-connector/26-rust.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/zh/08-connector/26-rust.mdx b/docs/zh/08-connector/26-rust.mdx index 9bb444d9e8..e1e94e068f 100644 --- a/docs/zh/08-connector/26-rust.mdx +++ b/docs/zh/08-connector/26-rust.mdx @@ -514,7 +514,6 @@ let assignments = consumer.assignments().await.unwrap(); 版本要求 connector-rust >= v0.8.8， TDengine >= 3.0.5.0 - ```rust consumer.offset_seek(topic, vgroup_id, offset).await; ``` From 87200591b082fc3823c414f7df4a3984c3b491d4 Mon Sep 17 00:00:00 2001 From: Adam Ji Date: Mon, 5 Jun 2023 15:17:07 +0800 Subject: [PATCH 5/5] docs: fmt lines --- docs/en/14-reference/03-connector/06-rust.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/14-reference/03-connector/06-rust.mdx b/docs/en/14-reference/03-connector/06-rust.mdx index 650d0d516d..fb7c368df1 100644 --- a/docs/en/14-reference/03-connector/06-rust.mdx +++ b/docs/en/14-reference/03-connector/06-rust.mdx @@ -501,7 +501,7 @@ The TMQ is of [futures::Stream](https://docs.rs/futures/latest/futures/stream/in Get assignments： -Version requirements connector-rust >= v0.8.8， TDengine >= 3.0.5.0 +Version requirements connector-rust >= v0.8.8, TDengine >= 3.0.5.0 ```rust let assignments = consumer.assignments().await.unwrap(); @@ -509,7 +509,7 @@ let assignments = consumer.assignments().await.unwrap(); Seek offset： -Version requirements connector-rust >= v0.8.8， TDengine >= 3.0.5.0 +Version requirements connector-rust >= v0.8.8, TDengine >= 3.0.5.0 ```rust consumer.offset_seek(topic, vgroup_id, offset).await;