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
......@@ -9,9 +9,13 @@
"function": "slowlogCommand",
"command_flags": [
"ADMIN",
"RANDOM",
"LOADING",
"STALE"
],
"command_tips": [
"REQUEST_POLICY:ALL_NODES",
"RESPONSE_POLICY:AGG_SUM",
"NONDETERMINISTIC_OUTPUT"
]
}
}
......@@ -11,6 +11,10 @@
"ADMIN",
"LOADING",
"STALE"
],
"command_tips": [
"REQUEST_POLICY:ALL_NODES",
"RESPONSE_POLICY:ALL_SUCCEEDED"
]
}
}
......@@ -7,12 +7,14 @@
"arity": 2,
"function": "sinterCommand",
"command_flags": [
"READONLY",
"SORT_FOR_SCRIPT"
"READONLY"
],
"acl_categories": [
"SET"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT_ORDER"
],
"key_specs": [
{
"flags": [
......
......@@ -14,12 +14,14 @@
],
"command_flags": [
"WRITE",
"RANDOM",
"FAST"
],
"acl_categories": [
"SET"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -13,12 +13,14 @@
]
],
"command_flags": [
"READONLY",
"RANDOM"
"READONLY"
],
"acl_categories": [
"SET"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -7,12 +7,14 @@
"arity": -3,
"function": "sscanCommand",
"command_flags": [
"READONLY",
"RANDOM"
"READONLY"
],
"acl_categories": [
"SET"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -7,12 +7,14 @@
"arity": -2,
"function": "sunionCommand",
"command_flags": [
"READONLY",
"SORT_FOR_SCRIPT"
"READONLY"
],
"acl_categories": [
"SET"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT_ORDER"
],
"key_specs": [
{
"flags": [
......
......@@ -7,10 +7,12 @@
"arity": 1,
"function": "timeCommand",
"command_flags": [
"RANDOM",
"LOADING",
"STALE",
"FAST"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
]
}
}
......@@ -13,6 +13,10 @@
"acl_categories": [
"KEYSPACE"
],
"command_tips": [
"REQUEST_POLICY:MULTI_SHARD",
"RESPONSE_POLICY:AGG_SUM"
],
"key_specs": [
{
"flags": [
......
......@@ -14,12 +14,14 @@
],
"command_flags": [
"READONLY",
"RANDOM",
"FAST"
],
"acl_categories": [
"KEYSPACE"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -13,6 +13,10 @@
"acl_categories": [
"KEYSPACE"
],
"command_tips": [
"REQUEST_POLICY:MULTI_SHARD",
"RESPONSE_POLICY:AGG_SUM"
],
"key_specs": [
{
"flags": [
......
......@@ -12,6 +12,10 @@
"acl_categories": [
"CONNECTION"
],
"command_tips": [
"REQUEST_POLICY:ALL_SHARDS",
"RESPONSE_POLICY:AGG_MIN"
],
"arguments": [
{
"name": "numreplicas",
......
......@@ -8,7 +8,6 @@
"function": "xackCommand",
"command_flags": [
"WRITE",
"RANDOM",
"FAST"
],
"acl_categories": [
......
......@@ -19,12 +19,14 @@
"command_flags": [
"WRITE",
"DENYOOM",
"RANDOM",
"FAST"
],
"acl_categories": [
"STREAM"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -8,12 +8,14 @@
"function": "xautoclaimCommand",
"command_flags": [
"WRITE",
"RANDOM",
"FAST"
],
"acl_categories": [
"STREAM"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -8,12 +8,14 @@
"function": "xclaimCommand",
"command_flags": [
"WRITE",
"RANDOM",
"FAST"
],
"acl_categories": [
"STREAM"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -8,12 +8,14 @@
"container": "XINFO",
"function": "xinfoCommand",
"command_flags": [
"READONLY",
"RANDOM"
"READONLY"
],
"acl_categories": [
"STREAM"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -13,12 +13,14 @@
]
],
"command_flags": [
"READONLY",
"RANDOM"
"READONLY"
],
"acl_categories": [
"STREAM"
],
"command_tips": [
"NONDETERMINISTIC_OUTPUT"
],
"key_specs": [
{
"flags": [
......
......@@ -8,11 +8,12 @@
"function": "xreadCommand",
"get_keys_function": "xreadGetKeys",
"command_flags": [
"READONLY"
"BLOCKING",
"READONLY",
"BLOCKING"
],
"acl_categories": [
"STREAM",
"BLOCKING"
"STREAM"
],
"key_specs": [
{
......
......@@ -8,11 +8,11 @@
"function": "xreadCommand",
"get_keys_function": "xreadGetKeys",
"command_flags": [
"BLOCKING",
"WRITE"
],
"acl_categories": [
"STREAM",
"BLOCKING"
"STREAM"
],
"key_specs": [
{
......
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