|
| 1 | +--- |
| 2 | +acl_categories: |
| 3 | +- '@admin' |
| 4 | +- '@slow' |
| 5 | +- '@dangerous' |
| 6 | +arguments: |
| 7 | +- arguments: |
| 8 | + - arguments: |
| 9 | + - display_text: start-slot |
| 10 | + name: start-slot |
| 11 | + type: integer |
| 12 | + - display_text: end-slot |
| 13 | + name: end-slot |
| 14 | + type: integer |
| 15 | + multiple: true |
| 16 | + name: import |
| 17 | + token: IMPORT |
| 18 | + type: block |
| 19 | + - arguments: |
| 20 | + - display_text: task-id |
| 21 | + name: task-id |
| 22 | + token: ID |
| 23 | + type: string |
| 24 | + - display_text: all |
| 25 | + name: all |
| 26 | + token: ALL |
| 27 | + type: pure-token |
| 28 | + name: cancel |
| 29 | + token: CANCEL |
| 30 | + type: oneof |
| 31 | + - arguments: |
| 32 | + - display_text: task-id |
| 33 | + name: task-id |
| 34 | + optional: true |
| 35 | + token: ID |
| 36 | + type: string |
| 37 | + - display_text: all |
| 38 | + name: all |
| 39 | + optional: true |
| 40 | + token: ALL |
| 41 | + type: pure-token |
| 42 | + name: status |
| 43 | + token: STATUS |
| 44 | + type: block |
| 45 | + name: subcommand |
| 46 | + type: oneof |
| 47 | +arity: -4 |
| 48 | +categories: |
| 49 | +- docs |
| 50 | +- develop |
| 51 | +- stack |
| 52 | +- oss |
| 53 | +- rs |
| 54 | +- rc |
| 55 | +- oss |
| 56 | +- kubernetes |
| 57 | +- clients |
| 58 | +command_flags: |
| 59 | +- admin |
| 60 | +- stale |
| 61 | +- no_async_loading |
| 62 | +complexity: O(N) where N is the total number of the slots between the start slot and |
| 63 | + end slot arguments. |
| 64 | +description: Start, monitor, and cancel atomic slot migration tasks. |
| 65 | +group: cluster |
| 66 | +hidden: false |
| 67 | +linkTitle: CLUSTER MIGRATION |
| 68 | +since: 8.4.0 |
| 69 | +summary: Start, monitor, and cancel atomic slot migration tasks. |
| 70 | +syntax_fmt: "CLUSTER MIGRATION <IMPORT\_start-slot end-slot [start-slot end-slot ...]\n\ |
| 71 | + \ | CANCEL\_<ID\_task-id | ALL> | STATUS\_<ID\_task-id | ALL>" |
| 72 | +syntax_str: '' |
| 73 | +title: CLUSTER MIGRATION |
| 74 | +--- |
| 75 | + |
| 76 | +The `CLUSTER MIGRATION` command provides atomic slot migration functionality for Redis Cluster. This command allows you to import slots from other nodes, monitor the progress of migration tasks, and cancel ongoing migrations. |
| 77 | + |
| 78 | +## Required arguments |
| 79 | + |
| 80 | +<details open><summary><code>subcommand</code></summary> |
| 81 | + |
| 82 | +The subcommand specifies the operation to perform: |
| 83 | + |
| 84 | +- `IMPORT <start-slot> <end-slot> [<start-slot> <end-slot> ...]`: Executes on the destination master. Accepts multiple slot ranges and triggers atomic migration for the specified ranges. Returns a task ID that you can use to monitor the status of the task. |
| 85 | + |
| 86 | +- `CANCEL <ID <task-id> | ALL>`: Cancels an ongoing migration task by its ID or cancels all tasks if `ALL` is specified. Note: Cancelling a task on the source node does not stop the migration on the destination node, which will continue retrying until it is also cancelled there. |
| 87 | + |
| 88 | +- `STATUS [ID <task-id> | ALL]`: Displays the status of current and completed atomic slot migration tasks. If a specific task ID is provided, it returns detailed information for that task only. If `ALL` is specified, it returns the status of all ongoing and completed tasks. |
| 89 | + |
| 90 | +</details> |
| 91 | + |
| 92 | +## Examples |
| 93 | + |
| 94 | +Import slots 0-1000 and 2000-3000 to the current node: |
| 95 | + |
| 96 | +```bash |
| 97 | +CLUSTER MIGRATION IMPORT 0 1000 2000 3000 |
| 98 | +``` |
| 99 | + |
| 100 | +Check the status of all migration tasks: |
| 101 | + |
| 102 | +```bash |
| 103 | +CLUSTER MIGRATION STATUS ALL |
| 104 | +``` |
| 105 | + |
| 106 | +Check the status of a specific migration task: |
| 107 | + |
| 108 | +```bash |
| 109 | +CLUSTER MIGRATION STATUS ID 24cf41718b20f7f05901743dffc40bc9b15db339 |
| 110 | +``` |
| 111 | + |
| 112 | +Cancel a specific migration task: |
| 113 | + |
| 114 | +```bash |
| 115 | +CLUSTER MIGRATION CANCEL ID 24cf41718b20f7f05901743dffc40bc9b15db339 |
| 116 | +``` |
| 117 | + |
| 118 | +Cancel all migration tasks: |
| 119 | + |
| 120 | +```bash |
| 121 | +CLUSTER MIGRATION CANCEL ALL |
| 122 | +``` |
| 123 | + |
| 124 | +## Redis Software and Redis Cloud compatibility |
| 125 | + |
| 126 | +| Redis<br />Enterprise | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |
| 127 | +|:----------------------|:-----------------|:------| |
| 128 | +| <span title="Not supported">❌ Standard</span><br /><span title="Not supported"><nobr>❌ Active-Active</nobr></span> | <span title="Not supported">❌ Standard</span><br /><span title="Not supported"><nobr>❌ Active-Active</nobr></span> | | |
| 129 | + |
| 130 | +## Return information |
| 131 | + |
| 132 | +{{< multitabs id="return-info" |
| 133 | + tab1="RESP2" |
| 134 | + tab2="RESP3" >}} |
| 135 | + |
| 136 | +For the `IMPORT` subcommand: |
| 137 | +[Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): task ID on success, or error message on failure. |
| 138 | + |
| 139 | +For the `CANCEL` subcommand: |
| 140 | +[Integer reply](../../develop/reference/protocol-spec#integers): number of cancelled tasks. |
| 141 | + |
| 142 | +For the `STATUS` subcommand: |
| 143 | +[Array reply](../../develop/reference/protocol-spec#arrays): a list of migration task details. Each task is represented as an array containing field-value pairs: |
| 144 | +- `id`: Task identifier |
| 145 | +- `slots`: Slot range being imported or migrated |
| 146 | +- `source`: Source node ID |
| 147 | +- `dest`: Destination node ID |
| 148 | +- `operation`: Operation type ("import" or "migrate") |
| 149 | +- `state`: Current state ("completed", "in_progress", etc.) |
| 150 | +- `last_error`: Last error message (empty if none) |
| 151 | +- `retries`: Number of retry attempts |
| 152 | +- `create_time`: Task creation timestamp |
| 153 | +- `start_time`: Task start timestamp |
| 154 | +- `end_time`: Task completion timestamp (if completed) |
| 155 | +- `write_pause_ms`: Write pause duration in milliseconds |
| 156 | + |
| 157 | +-tab-sep- |
| 158 | + |
| 159 | +For the `IMPORT` subcommand: |
| 160 | +[Bulk string reply](../../develop/reference/protocol-spec#bulk-strings): task ID on success, or error message on failure. |
| 161 | + |
| 162 | +For the `CANCEL` subcommand: |
| 163 | +[Integer reply](../../develop/reference/protocol-spec#integers): number of cancelled tasks. |
| 164 | + |
| 165 | +For the `STATUS` subcommand: |
| 166 | +[Array reply](../../develop/reference/protocol-spec#arrays): a list of migration task details. Each task is represented as an array containing field-value pairs: |
| 167 | +- `id`: Task identifier |
| 168 | +- `slots`: Slot range being migrated |
| 169 | +- `source`: Source node ID |
| 170 | +- `dest`: Destination node ID |
| 171 | +- `operation`: Operation type (typically "migrate") |
| 172 | +- `state`: Current state ("completed", "in_progress", etc.) |
| 173 | +- `last_error`: Last error message (empty if none) |
| 174 | +- `retries`: Number of retry attempts |
| 175 | +- `create_time`: Task creation timestamp |
| 176 | +- `start_time`: Task start timestamp |
| 177 | +- `end_time`: Task completion timestamp (if completed) |
| 178 | +- `write_pause_ms`: Write pause duration in milliseconds |
| 179 | + |
| 180 | +{{< /multitabs >}} |
| 181 | + |
| 182 | +## Notes |
| 183 | + |
| 184 | +- The atomic slot migration feature is available starting from Redis 8.4.0. |
| 185 | +- Cancelling a task on the source node does not automatically stop the migration on the destination node. |
| 186 | +- In `CLUSTER MIGRATION STATUS` output, the "state" field will show `completed` for successful operations. |
| 187 | +- Tasks with empty "last_error" fields indicate no errors occurred during the migration process. |
| 188 | + |
| 189 | +## Key visibility during migration |
| 190 | + |
| 191 | +During atomic slot migration operations, keys in unowned slotsmay be filtered out from the following commands while importing or trimming is in progress: |
| 192 | + |
| 193 | +- [`KEYS`]({{< relref "/commands/keys" >}}) |
| 194 | +- [`SCAN`]({{< relref "/commands/scan" >}}) |
| 195 | +- [`RANDOMKEY`]({{< relref "/commands/randomkey" >}}) |
| 196 | +- [`CLUSTER GETKEYSINSLOT`]({{< relref "/commands/cluster-getkeysinslot" >}}) |
| 197 | +- [`DBSIZE`]({{< relref "/commands/dbsize" >}}) |
| 198 | +- [`CLUSTER COUNTKEYSINSLOT`]({{< relref "/commands/cluster-countkeysinslot" >}}) |
| 199 | + |
| 200 | +The [`INFO KEYSPACE`]({{< relref "/commands/info" >}}) command will continue to reflect the actual number of keys, including those being imported. |
| 201 | + |
| 202 | +## Related configuration |
| 203 | + |
| 204 | +- `cluster-slot-migration-handoff-max-lag-bytes`: After slot snapshot completion, if remaining replication stream size falls below this threshold, the source node pauses writes to hand off slot ownership. Higher values trigger handoff earlier but may cause longer write pauses. Lower values result in shorter write pauses but may be harder to reach with steady incoming writes (default: 1MB). |
| 205 | +- `cluster-slot-migration-write-pause-timeout`: Maximum duration that the source node pauses writes during ASM handoff. If the destination fails to take over slots within this timeout, the source assumes migration failed and resumes writes (default: 10 seconds). |
0 commit comments