Skip to content

docs: fix region migration timeout parameter docs #2485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
WenyXu merged 1 commit into from
May 19, 2026
Merged

docs: fix region migration timeout parameter docs #2485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/user-guide/deployments-administration/manage-data/region-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ ADMIN migrate_region(4398046511104, 1, 2, 60);
The parameters of `migrate_region`：

```sql
ADMIN migrate_region(region_id, from_peer_id, to_peer_id);
ADMIN migrate_region(region_id, from_peer_id, to_peer_id, replay_timeout);
```

Expand All @@ -63,7 +64,7 @@ ADMIN migrate_region(region_id, from_peer_id, to_peer_id, replay_timeout);
| `region_id` | The region id. | **Required** | |
| `from_peer_id` | The peer id of the migration source(Datanode). | **Required** | |
| `to_peer_id` | The peer id of the migration destination(Datanode). | **Required** | |
| `replay_timeout` | The timeout(secs) of replay data. If the new Region fails to replay the data within the specified timeout, the migration will fail, however the data in the old Region will not be lost. | Optional | |
| `replay_timeout` | The timeout (in seconds) for replaying data. Defaults to 300 seconds if omitted. If the new Region fails to replay the data within the specified timeout, the migration will fail, however the data in the old Region will not be lost. | Optional | |

## Query the migration state

Expand All @@ -80,4 +81,3 @@ If it's done, outputs the state in JSON:
```

Of course, you can confirm the region distribution by querying from `region_peers` and `partitions` in `information_schema`.

3 changes: 2 additions & 1 deletion ...s/current/user-guide/deployments-administration/manage-data/region-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ ADMIN migrate_region(4398046511104, 1, 2, 60);
`migrate_region` 参数说明：

```sql
ADMIN migrate_region(region_id, from_peer_id, to_peer_id);
ADMIN migrate_region(region_id, from_peer_id, to_peer_id, replay_timeout);
```

Expand All @@ -62,7 +63,7 @@ ADMIN migrate_region(region_id, from_peer_id, to_peer_id, replay_timeout);
| `region_id` | Region Id | **Required** | |
| `from_peer_id` | 迁移起始节点 (Datanode) 的 peer id。 | **Required** | |
| `to_peer_id` | 迁移目标节点 (Datanode) 的 peer id。 | **Required** | |
| `replay_timeout` | 迁移时回放数据的超时时间（单位：秒）。如果新 Region 未能在指定时间内回放数据，迁移将失败，旧 Region 中的数据不会丢失。 | Optional | |
| `replay_timeout` | 迁移时回放数据的超时时间（单位：秒）。省略时默认 300 秒。如果新 Region 未能在指定时间内回放数据，迁移将失败，旧 Region 中的数据不会丢失。 | Optional | |

## 查询迁移状态

Expand Down
3 changes: 2 additions & 1 deletion ...rsion-1.0/user-guide/deployments-administration/manage-data/region-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ ADMIN migrate_region(4398046511104, 1, 2, 60);
`migrate_region` 参数说明：

```sql
ADMIN migrate_region(region_id, from_peer_id, to_peer_id);
ADMIN migrate_region(region_id, from_peer_id, to_peer_id, replay_timeout);
```

Expand All @@ -62,7 +63,7 @@ ADMIN migrate_region(region_id, from_peer_id, to_peer_id, replay_timeout);
| `region_id` | Region Id | **Required** | |
| `from_peer_id` | 迁移起始节点 (Datanode) 的 peer id。 | **Required** | |
| `to_peer_id` | 迁移目标节点 (Datanode) 的 peer id。 | **Required** | |
| `replay_timeout` | 迁移时回放数据的超时时间（单位：秒）。如果新 Region 未能在指定时间内回放数据，迁移将失败，旧 Region 中的数据不会丢失。 | Optional | |
| `replay_timeout` | 迁移时回放数据的超时时间（单位：秒）。省略时默认 300 秒。如果新 Region 未能在指定时间内回放数据，迁移将失败，旧 Region 中的数据不会丢失。 | Optional | |

## 查询迁移状态

Expand Down
4 changes: 2 additions & 2 deletions ...rsion-1.0/user-guide/deployments-administration/manage-data/region-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ ADMIN migrate_region(4398046511104, 1, 2, 60);
The parameters of `migrate_region`：

```sql
ADMIN migrate_region(region_id, from_peer_id, to_peer_id);
ADMIN migrate_region(region_id, from_peer_id, to_peer_id, replay_timeout);
```

Expand All @@ -63,7 +64,7 @@ ADMIN migrate_region(region_id, from_peer_id, to_peer_id, replay_timeout);
| `region_id` | The region id. | **Required** | |
| `from_peer_id` | The peer id of the migration source(Datanode). | **Required** | |
| `to_peer_id` | The peer id of the migration destination(Datanode). | **Required** | |
| `replay_timeout` | The timeout(secs) of replay data. If the new Region fails to replay the data within the specified timeout, the migration will fail, however the data in the old Region will not be lost. | Optional | |
| `replay_timeout` | The timeout (in seconds) for replaying data. Defaults to 300 seconds if omitted. If the new Region fails to replay the data within the specified timeout, the migration will fail, however the data in the old Region will not be lost. | Optional | |

## Query the migration state

Expand All @@ -80,4 +81,3 @@ If it's done, outputs the state in JSON:
```

Of course, you can confirm the region distribution by querying from `region_peers` and `partitions` in `information_schema`.

Loading