summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/sort_ro.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/sort_ro.md')
-rw-r--r--iredis/data/commands/sort_ro.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/iredis/data/commands/sort_ro.md b/iredis/data/commands/sort_ro.md
new file mode 100644
index 0000000..66223a3
--- /dev/null
+++ b/iredis/data/commands/sort_ro.md
@@ -0,0 +1,17 @@
+Read-only variant of the `SORT` command. It is exactly like the original `SORT` but refuses the `STORE` option and can safely be used in read-only replicas.
+
+Since the original `SORT` has a `STORE` option it is technically flagged as a writing command in the Redis command table. For this reason read-only replicas in a Redis Cluster will redirect it to the master instance even if the connection is in read-only mode (see the `READONLY` command of Redis Cluster).
+
+The `SORT_RO` variant was introduced in order to allow `SORT` behavior in read-only replicas without breaking compatibility on command flags.
+
+See original `SORT` for more details.
+
+@examples
+
+```
+SORT_RO mylist BY weight_*->fieldname GET object_*->fieldname
+```
+
+@return
+
+@array-reply: a list of sorted elements.