Unverified Commit 10bbeb68 authored by guybe7's avatar guybe7 Committed by GitHub
Browse files

Add command tips to COMMAND DOCS (#10104)

Adding command tips (see https://redis.io/topics/command-tips) to commands.

Breaking changes:
1. Removed the "random" and "sort_for_script" flags. They are now command tips.
(this isn't affecting redis behavior since #9812, but could affect some client applications
that's relying on COMMAND command flags)

Summary of changes:
1. add BLOCKING flag (new flag) for all commands that could block. The ACL category with
  the same name is now implicit.
2. move RANDOM flag to a `nondeterministic_output` tip
3. move SORT_FOR_SCRIPT flag to `nondeterministic_output_order` tip
3. add REQUEST_POLICY and RESPONSE_POLICY where appropriate as documented in the tips
4. deprecate (ignore) the `random` flag for RM_CreateCommand

Other notes:
1. Proxies need to send `RANDOMKEY` to all shards and then select one key randomly.
  The other option is to pick a random shard and transfer `RANDOMKEY `to it, but that scheme
  fails if this specific shard is empty
2. Remove CMD_RANDOM from `XACK` (i.e. XACK does not have RANDOM_OUTPUT)
   It was added in 9e4fb96c, I guess by mistake.
   Also from `(P)EXPIRETIME` (new command, was flagged "random" by mistake).
3. Add `nondeterministic_output` to `OBJECT ENCODING` (for the same reason `XTRIM` has it:
   the reply may differ depending on the internal representation in memory)
4. RANDOM on `HGETALL` was wrong (there due to a limitation of the old script sorting logic), now
  it's `nondeterministic_output_order`
5. Unrelated: Hide CMD_PROTECTED from COMMAND
parent 9c602922
...@@ -10,9 +10,11 @@ ...@@ -10,9 +10,11 @@
"command_flags": [ "command_flags": [
"NO_ASYNC_LOADING", "NO_ASYNC_LOADING",
"ADMIN", "ADMIN",
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "node-id", "name": "node-id",
......
...@@ -8,9 +8,11 @@ ...@@ -8,9 +8,11 @@
"container": "CLUSTER", "container": "CLUSTER",
"function": "clusterCommand", "function": "clusterCommand",
"command_flags": [ "command_flags": [
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "slot", "name": "slot",
......
...@@ -8,8 +8,10 @@ ...@@ -8,8 +8,10 @@
"container": "CLUSTER", "container": "CLUSTER",
"function": "clusterCommand", "function": "clusterCommand",
"command_flags": [ "command_flags": [
"RANDOM",
"STALE" "STALE"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
] ]
} }
} }
...@@ -8,9 +8,11 @@ ...@@ -8,9 +8,11 @@
"container": "CLUSTER", "container": "CLUSTER",
"function": "clusterCommand", "function": "clusterCommand",
"command_flags": [ "command_flags": [
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "key", "name": "key",
......
...@@ -8,8 +8,10 @@ ...@@ -8,8 +8,10 @@
"container": "CLUSTER", "container": "CLUSTER",
"function": "clusterCommand", "function": "clusterCommand",
"command_flags": [ "command_flags": [
"RANDOM",
"STALE" "STALE"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
] ]
} }
} }
...@@ -10,9 +10,11 @@ ...@@ -10,9 +10,11 @@
"command_flags": [ "command_flags": [
"NO_ASYNC_LOADING", "NO_ASYNC_LOADING",
"ADMIN", "ADMIN",
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "ip", "name": "ip",
......
...@@ -8,8 +8,10 @@ ...@@ -8,8 +8,10 @@
"container": "CLUSTER", "container": "CLUSTER",
"function": "clusterCommand", "function": "clusterCommand",
"command_flags": [ "command_flags": [
"RANDOM",
"STALE" "STALE"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
] ]
} }
} }
...@@ -8,8 +8,10 @@ ...@@ -8,8 +8,10 @@
"container": "CLUSTER", "container": "CLUSTER",
"function": "clusterCommand", "function": "clusterCommand",
"command_flags": [ "command_flags": [
"RANDOM",
"STALE" "STALE"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
] ]
} }
} }
...@@ -9,9 +9,11 @@ ...@@ -9,9 +9,11 @@
"function": "clusterCommand", "function": "clusterCommand",
"command_flags": [ "command_flags": [
"ADMIN", "ADMIN",
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "node-id", "name": "node-id",
......
...@@ -10,9 +10,11 @@ ...@@ -10,9 +10,11 @@
"command_flags": [ "command_flags": [
"NO_ASYNC_LOADING", "NO_ASYNC_LOADING",
"ADMIN", "ADMIN",
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "node-id", "name": "node-id",
......
...@@ -9,10 +9,12 @@ ...@@ -9,10 +9,12 @@
"function": "clusterCommand", "function": "clusterCommand",
"command_flags": [ "command_flags": [
"ADMIN", "ADMIN",
"RANDOM",
"STALE", "STALE",
"NOSCRIPT" "NOSCRIPT"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "hard_soft", "name": "hard_soft",
......
...@@ -10,8 +10,10 @@ ...@@ -10,8 +10,10 @@
"command_flags": [ "command_flags": [
"NO_ASYNC_LOADING", "NO_ASYNC_LOADING",
"ADMIN", "ADMIN",
"RANDOM",
"STALE" "STALE"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
] ]
} }
} }
...@@ -10,9 +10,11 @@ ...@@ -10,9 +10,11 @@
"command_flags": [ "command_flags": [
"NO_ASYNC_LOADING", "NO_ASYNC_LOADING",
"ADMIN", "ADMIN",
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "config-epoch", "name": "config-epoch",
......
...@@ -10,9 +10,11 @@ ...@@ -10,9 +10,11 @@
"command_flags": [ "command_flags": [
"NO_ASYNC_LOADING", "NO_ASYNC_LOADING",
"ADMIN", "ADMIN",
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "slot", "name": "slot",
......
...@@ -11,9 +11,11 @@ ...@@ -11,9 +11,11 @@
"replaced_by": "`CLUSTER REPLICAS`", "replaced_by": "`CLUSTER REPLICAS`",
"command_flags": [ "command_flags": [
"ADMIN", "ADMIN",
"RANDOM",
"STALE" "STALE"
], ],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"arguments": [ "arguments": [
{ {
"name": "node-id", "name": "node-id",
......
...@@ -14,8 +14,10 @@ ...@@ -14,8 +14,10 @@
] ]
], ],
"command_flags": [ "command_flags": [
"RANDOM",
"STALE" "STALE"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
] ]
} }
} }
...@@ -7,13 +7,15 @@ ...@@ -7,13 +7,15 @@
"arity": -1, "arity": -1,
"function": "commandCommand", "function": "commandCommand",
"command_flags": [ "command_flags": [
"RANDOM",
"LOADING", "LOADING",
"STALE", "STALE",
"SENTINEL" "SENTINEL"
], ],
"acl_categories": [ "acl_categories": [
"CONNECTION" "CONNECTION"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
] ]
} }
} }
...@@ -19,6 +19,10 @@ ...@@ -19,6 +19,10 @@
"LOADING", "LOADING",
"STALE" "STALE"
], ],
"command_tips": [
"REQUEST_POLICY:ALL_NODES",
"RESPONSE_POLICY:ALL_SUCCEEDED"
],
"arguments": [ "arguments": [
{ {
"name": "parameter_value", "name": "parameter_value",
......
...@@ -12,6 +12,10 @@ ...@@ -12,6 +12,10 @@
], ],
"acl_categories": [ "acl_categories": [
"KEYSPACE" "KEYSPACE"
],
"command_tips": [
"REQUEST_POLICY:ALL_SHARDS",
"RESPONSE_POLICY:AGG_SUM"
] ]
} }
} }
...@@ -12,6 +12,10 @@ ...@@ -12,6 +12,10 @@
"acl_categories": [ "acl_categories": [
"KEYSPACE" "KEYSPACE"
], ],
"command_tips": [
"REQUEST_POLICY:MULTI_SHARD",
"RESPONSE_POLICY:AGG_SUM"
],
"key_specs": [ "key_specs": [
{ {
"flags": [ "flags": [
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment