This is an automated email from the ASF dual-hosted git repository.
HTHou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new b3e305d0 docs: add write-back sink parameters (#1126)
b3e305d0 is described below
commit b3e305d0a6021e80a40f7520590af09546c8f78c
Author: leto-b <[email protected]>
AuthorDate: Wed May 27 15:06:28 2026 +0800
docs: add write-back sink parameters (#1126)
* docs: add write-back sink parameters
* docs: update kafka programming guide
---
src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md | 5 +++++
src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md | 5 +++++
src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md | 5 +++++
src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md | 5 +++++
4 files changed, 20 insertions(+)
diff --git a/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
b/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
index 9628b6d3..98bf4724 100644
--- a/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
@@ -755,6 +755,11 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| **Parameter** | **Description**
| **value Range**
| **Required** | **Default Value** |
| ---------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | --------
|--------------|
| sink | write-back-sink
| String: write-back-sink | Yes
| - |
+| user/username | User used for write-back
| String: username |
Optional | root |
+| password | Password used for write-back
| String: password |
Optional | root123 |
+| user-id | User ID corresponding to the user
| String |
Optional | root |
+| cli-hostname | CLI hostname corresponding to the user
| String |
Optional | root |
+| use-event-user-name | Whether to use another user's username if the
event contains one (generally not needed now because there is no external
source) | Boolean: true / false |
Optional | false |
#### opc-ua-sink
diff --git a/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
b/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
index 9628b6d3..98bf4724 100644
--- a/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
+++ b/src/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
@@ -755,6 +755,11 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| **Parameter** | **Description**
| **value Range**
| **Required** | **Default Value** |
| ---------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | --------
|--------------|
| sink | write-back-sink
| String: write-back-sink | Yes
| - |
+| user/username | User used for write-back
| String: username |
Optional | root |
+| password | Password used for write-back
| String: password |
Optional | root123 |
+| user-id | User ID corresponding to the user
| String |
Optional | root |
+| cli-hostname | CLI hostname corresponding to the user
| String |
Optional | root |
+| use-event-user-name | Whether to use another user's username if the
event contains one (generally not needed now because there is no external
source) | Boolean: true / false |
Optional | false |
#### opc-ua-sink
diff --git a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
index 99d523cd..e010e6f6 100644
--- a/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
+++ b/src/zh/UserGuide/Master/Table/User-Manual/Data-Sync_timecho.md
@@ -750,6 +750,11 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
| ---------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
-------- |
| sink | write-back-sink
| String: write-back-sink | 必填
| - |
+| user/username | 用于写回的用户
| String：用户名 | 选填 |
root |
+| password | 用于写回的密码
| String：密码 | 选填 |
root123 |
+| user-id | 用户对应的 userId
| String | 选填
| root |
+| cli-hostname | 用户对应的 cli 主机名
| String | 选填
| root |
+| use-event-user-name | 如果 event 中含有另一个用户的用户名，是否使用该用户名（现在没有 external
source 基本不需要） | Boolean: true / false |
选填 | false |
#### opc-ua-sink
diff --git a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
index 99d523cd..e010e6f6 100644
--- a/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
+++ b/src/zh/UserGuide/latest-Table/User-Manual/Data-Sync_timecho.md
@@ -750,6 +750,11 @@ pipe_all_sinks_rate_limit_bytes_per_second=-1
| **参数** | **描述**
| **value 取值范围** | **是否必填** |
**默认取值** |
| ---------------------------- |
------------------------------------------------------------ |
------------------------------------------------------------ | -------- |
-------- |
| sink | write-back-sink
| String: write-back-sink | 必填
| - |
+| user/username | 用于写回的用户
| String：用户名 | 选填 |
root |
+| password | 用于写回的密码
| String：密码 | 选填 |
root123 |
+| user-id | 用户对应的 userId
| String | 选填
| root |
+| cli-hostname | 用户对应的 cli 主机名
| String | 选填
| root |
+| use-event-user-name | 如果 event 中含有另一个用户的用户名，是否使用该用户名（现在没有 external
source 基本不需要） | Boolean: true / false |
选填 | false |
#### opc-ua-sink
