Skip to content

Commit d486cde

Browse files
Region migration contents update (#523)
* try * try * copy
1 parent 1943b2c commit d486cde

File tree

6 files changed

+64
-9
lines changed

6 files changed

+64
-9
lines changed

src/UserGuide/Master/Tree/User-Manual/Load-Balance.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Here is a schematic diagram of the region migration process :
3939

4040
1. It is recommended to only use the Region Migration feature on IoTDB 1.3.3 and higher versions.
4141
2. Region migration is only supported when the consensus protocol is IoTConsus or Ratis (in iotdb system. properties, the `schema_region_consensus_protocol_class` and`data_region_consensus_protocol_class`).
42-
3. Region migration will occupy system resources such as hard drives and network bandwidth, and it is recommended to perform it during low business loads.
43-
4. The region migration process will occupy WAL files, blocking the deletion of WAL files in this consensus group. If the total number of WAL files reaches `wal_file_size_threshold_in_byte`, writing will be blocked.
42+
3. Region migration consumes system resources such as disk space and network bandwidth. It is recommended to perform the migration during periods of low business load.
43+
4. Under ideal circumstances, Region migration does not affect user-side read or write operations. In special cases, Region migration may block writes. For detailed identification and handling of such situations, please refer to the user guide.
4444

4545
### Instructions for use
4646

@@ -93,3 +93,12 @@ Here is a schematic diagram of the region migration process :
9393
Total line number = 3
9494
It costs 0.003s
9595
```
96+
- **Block Write**:
97+
The region migration in IoTConsensus does not directly block writes. However, since the process requires suspending the cleanup of WAL files, if the accumulated WAL files exceed the threshold defined by wal_throttle_threshold_in_byte, the current DataNode will pause writing until the WAL files fall below the threshold.
98+
99+
If a write error occurs during the migration due to the WAL exceeding the threshold (e.g., an error message like “The write is rejected because the wal directory size has reached the threshold”), you can increase the wal_throttle_threshold_in_byte value to 500GB or more to allow continued writing. Use the following SQL statement:
100+
101+
```plain
102+
IoTDB> set configuration "wal_throttle_threshold_in_byte"="536870912000"
103+
Msg: The statement is executed successfully.
104+
```

src/UserGuide/V2.0.1/Tree/User-Manual/Load-Balance.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Here is a schematic diagram of the region migration process :
3939

4040
1. It is recommended to only use the Region Migration feature on IoTDB 1.3.3 and higher versions.
4141
2. Region migration is only supported when the consensus protocol is IoTConsus or Ratis (in iotdb system. properties, the `schema_region_consensus_protocol_class` and`data_region_consensus_protocol_class`).
42-
3. Region migration will occupy system resources such as hard drives and network bandwidth, and it is recommended to perform it during low business loads.
43-
4. The region migration process will occupy WAL files, blocking the deletion of WAL files in this consensus group. If the total number of WAL files reaches `wal_file_size_threshold_in_byte`, writing will be blocked.
42+
3. Region migration consumes system resources such as disk space and network bandwidth. It is recommended to perform the migration during periods of low business load.
43+
4. Under ideal circumstances, Region migration does not affect user-side read or write operations. In special cases, Region migration may block writes. For detailed identification and handling of such situations, please refer to the user guide.
4444

4545
### Instructions for use
4646

@@ -93,3 +93,12 @@ Here is a schematic diagram of the region migration process :
9393
Total line number = 3
9494
It costs 0.003s
9595
```
96+
- **Block Write**:
97+
The region migration in IoTConsensus does not directly block writes. However, since the process requires suspending the cleanup of WAL files, if the accumulated WAL files exceed the threshold defined by wal_throttle_threshold_in_byte, the current DataNode will pause writing until the WAL files fall below the threshold.
98+
99+
If a write error occurs during the migration due to the WAL exceeding the threshold (e.g., an error message like “The write is rejected because the wal directory size has reached the threshold”), you can increase the wal_throttle_threshold_in_byte value to 500GB or more to allow continued writing. Use the following SQL statement:
100+
101+
```plain
102+
IoTDB> set configuration "wal_throttle_threshold_in_byte"="536870912000"
103+
Msg: The statement is executed successfully.
104+
```

src/UserGuide/latest/User-Manual/Load-Balance.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Here is a schematic diagram of the region migration process :
3939

4040
1. It is recommended to only use the Region Migration feature on IoTDB 1.3.3 and higher versions.
4141
2. Region migration is only supported when the consensus protocol is IoTConsus or Ratis (in iotdb system. properties, the `schema_region_consensus_protocol_class` and`data_region_consensus_protocol_class`).
42-
3. Region migration will occupy system resources such as hard drives and network bandwidth, and it is recommended to perform it during low business loads.
43-
4. The region migration process will occupy WAL files, blocking the deletion of WAL files in this consensus group. If the total number of WAL files reaches `wal_file_size_threshold_in_byte`, writing will be blocked.
42+
3. Region migration consumes system resources such as disk space and network bandwidth. It is recommended to perform the migration during periods of low business load.
43+
4. Under ideal circumstances, Region migration does not affect user-side read or write operations. In special cases, Region migration may block writes. For detailed identification and handling of such situations, please refer to the user guide.
4444

4545
### Instructions for use
4646

@@ -93,3 +93,12 @@ Here is a schematic diagram of the region migration process :
9393
Total line number = 3
9494
It costs 0.003s
9595
```
96+
- **Block Write**:
97+
The region migration in IoTConsensus does not directly block writes. However, since the process requires suspending the cleanup of WAL files, if the accumulated WAL files exceed the threshold defined by wal_throttle_threshold_in_byte, the current DataNode will pause writing until the WAL files fall below the threshold.
98+
99+
If a write error occurs during the migration due to the WAL exceeding the threshold (e.g., an error message like “The write is rejected because the wal directory size has reached the threshold”), you can increase the wal_throttle_threshold_in_byte value to 500GB or more to allow continued writing. Use the following SQL statement:
100+
101+
```plain
102+
IoTDB> set configuration "wal_throttle_threshold_in_byte"="536870912000"
103+
Msg: The statement is executed successfully.
104+
```

src/zh/UserGuide/Master/Tree/User-Manual/Load-Balance.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ IoTDB 是一个分布式数据库,数据的均衡分布对集群的磁盘空
3939
1. 推荐仅在 IoTDB 1.3.3 以及更高版本使用 Region 迁移功能。
4040
2. 仅在共识协议为 IoTConsensus、Ratis 时支持 Region 迁移(iotdb-system.properties中的`schema_region_consensus_protocol_class``data_region_consensus_protocol_class`)。
4141
3. Region 迁移会占用硬盘和网络带宽等系统资源,推荐在低业务负载时进行。
42-
4. Region 迁移过程会占用 WAL 文件,阻塞本共识组 WAL 文件的删除,如果 WAL 文件总量达到`wal_file_size_threshold_in_byte`,则会阻塞写入
42+
4. 在理想情况下,Region 迁移不影响用户侧读写。特殊情况下,Region 迁移可能阻塞写入,这种情况的具体鉴别与处理方式见使用说明
4343

4444
### 使用说明
4545

@@ -99,3 +99,12 @@ IoTDB 是一个分布式数据库,数据的均衡分布对集群的磁盘空
9999
It costs 0.003s
100100
```
101101

102+
- **阻塞写入**
103+
104+
IoTConsensus 的 region 迁移不直接阻塞写入,但由于过程中需要阻塞 WAL 文件的清理,如果 WAL 文件堆积达到阈值`wal_throttle_threshold_in_byte`,那么当前 DataNode 会暂停写入,直到 WAL 文件恢复到阈值以下。
105+
106+
如果迁移过程中由于 WAL 达到阈值造成写入报错(例如报错信息为 The write is rejected because the wal directory size has reached the threshold),可以将`wal_throttle_threshold_in_byte`调大到 500GB 或更大以允许继续写入。使用 SQL 语句:
107+
```plain
108+
IoTDB> set configuration "wal_throttle_threshold_in_byte"="536870912000"
109+
Msg: The statement is executed successfully.
110+
```

src/zh/UserGuide/V2.0.1/Tree/User-Manual/Load-Balance.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ IoTDB 是一个分布式数据库,数据的均衡分布对集群的磁盘空
3939
1. 推荐仅在 IoTDB 1.3.3 以及更高版本使用 Region 迁移功能。
4040
2. 仅在共识协议为 IoTConsensus、Ratis 时支持 Region 迁移(iotdb-system.properties中的`schema_region_consensus_protocol_class``data_region_consensus_protocol_class`)。
4141
3. Region 迁移会占用硬盘和网络带宽等系统资源,推荐在低业务负载时进行。
42-
4. Region 迁移过程会占用 WAL 文件,阻塞本共识组 WAL 文件的删除,如果 WAL 文件总量达到`wal_file_size_threshold_in_byte`,则会阻塞写入
42+
4. 在理想情况下,Region 迁移不影响用户侧读写。特殊情况下,Region 迁移可能阻塞写入,这种情况的具体鉴别与处理方式见使用说明
4343

4444
### 使用说明
4545

@@ -99,3 +99,12 @@ IoTDB 是一个分布式数据库,数据的均衡分布对集群的磁盘空
9999
It costs 0.003s
100100
```
101101

102+
- **阻塞写入**
103+
104+
IoTConsensus 的 region 迁移不直接阻塞写入,但由于过程中需要阻塞 WAL 文件的清理,如果 WAL 文件堆积达到阈值`wal_throttle_threshold_in_byte`,那么当前 DataNode 会暂停写入,直到 WAL 文件恢复到阈值以下。
105+
106+
如果迁移过程中由于 WAL 达到阈值造成写入报错(例如报错信息为 The write is rejected because the wal directory size has reached the threshold),可以将`wal_throttle_threshold_in_byte`调大到 500GB 或更大以允许继续写入。使用 SQL 语句:
107+
```plain
108+
IoTDB> set configuration "wal_throttle_threshold_in_byte"="536870912000"
109+
Msg: The statement is executed successfully.
110+
```

src/zh/UserGuide/latest/User-Manual/Load-Balance.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ IoTDB 是一个分布式数据库,数据的均衡分布对集群的磁盘空
3939
1. 推荐仅在 IoTDB 1.3.3 以及更高版本使用 Region 迁移功能。
4040
2. 仅在共识协议为 IoTConsensus、Ratis 时支持 Region 迁移(iotdb-system.properties中的`schema_region_consensus_protocol_class``data_region_consensus_protocol_class`)。
4141
3. Region 迁移会占用硬盘和网络带宽等系统资源,推荐在低业务负载时进行。
42-
4. Region 迁移过程会占用 WAL 文件,阻塞本共识组 WAL 文件的删除,如果 WAL 文件总量达到`wal_file_size_threshold_in_byte`,则会阻塞写入
42+
4. 在理想情况下,Region 迁移不影响用户侧读写。特殊情况下,Region 迁移可能阻塞写入,这种情况的具体鉴别与处理方式见使用说明
4343

4444
### 使用说明
4545

@@ -99,3 +99,13 @@ IoTDB 是一个分布式数据库,数据的均衡分布对集群的磁盘空
9999
It costs 0.003s
100100
```
101101

102+
- **阻塞写入**
103+
104+
IoTConsensus 的 region 迁移不直接阻塞写入,但由于过程中需要阻塞 WAL 文件的清理,如果 WAL 文件堆积达到阈值`wal_throttle_threshold_in_byte`,那么当前 DataNode 会暂停写入,直到 WAL 文件恢复到阈值以下。
105+
106+
如果迁移过程中由于 WAL 达到阈值造成写入报错(例如报错信息为 The write is rejected because the wal directory size has reached the threshold),可以将`wal_throttle_threshold_in_byte`调大到 500GB 或更大以允许继续写入。使用 SQL 语句:
107+
```plain
108+
IoTDB> set configuration "wal_throttle_threshold_in_byte"="536870912000"
109+
Msg: The statement is executed successfully.
110+
```
111+

0 commit comments

Comments
 (0)