diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2020-03-21 10:28:17 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-02-07 11:16:53 +0000 |
commit | 06cba6ccd165ca8b224797e37fccb9e63f026d77 (patch) | |
tree | e82f1bc439997ae296f2e74f8a64d84c5d95f140 /iredis/data/commands/cluster-reset.md | |
parent | Initial commit. (diff) | |
download | iredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.tar.xz iredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.zip |
Adding upstream version 1.9.1.upstream/1.9.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'iredis/data/commands/cluster-reset.md')
-rw-r--r-- | iredis/data/commands/cluster-reset.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/iredis/data/commands/cluster-reset.md b/iredis/data/commands/cluster-reset.md new file mode 100644 index 0000000..4186725 --- /dev/null +++ b/iredis/data/commands/cluster-reset.md @@ -0,0 +1,29 @@ +Reset a Redis Cluster node, in a more or less drastic way depending on the reset +type, that can be **hard** or **soft**. Note that this command **does not work +for masters if they hold one or more keys**, in that case to completely reset a +master node keys must be removed first, e.g. by using `FLUSHALL` first, and then +`CLUSTER RESET`. + +Effects on the node: + +1. All the other nodes in the cluster are forgotten. +2. All the assigned / open slots are reset, so the slots-to-nodes mapping is + totally cleared. +3. If the node is a replica it is turned into an (empty) master. Its dataset is + flushed, so at the end the node will be an empty master. +4. **Hard reset only**: a new Node ID is generated. +5. **Hard reset only**: `currentEpoch` and `configEpoch` vars are set to 0. +6. The new configuration is persisted on disk in the node cluster configuration + file. + +This command is mainly useful to re-provision a Redis Cluster node in order to +be used in the context of a new, different cluster. The command is also +extensively used by the Redis Cluster testing framework in order to reset the +state of the cluster every time a new test unit is executed. + +If no reset type is specified, the default is **soft**. + +@return + +@simple-string-reply: `OK` if the command was successful. Otherwise an error is +returned. |