Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes to resp2_replies.json and resp3_replies.json #202

Merged
merged 1 commit into from
Dec 24, 2024
Merged

Fixes to resp2_replies.json and resp3_replies.json #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions resp2_replies.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@
"ACL LIST": [
"[Array reply](../topics/protocol.md#arrays): an array of [Bulk string reply](../topics/protocol.md#bulk-strings) elements."
],
"ACL LOAD": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` on success.",
"",
"The command may fail with an error for several reasons: if the file is not readable, if there is an error inside the file, and in such cases, the error will be reported to the user in the error.",
"Finally, the command will fail if the server is not configured to use an external ACL file."
],
"ACL LOG": [
"When called to show security events:",
"* [Array reply](../topics/protocol.md#arrays): an array of [Bulk string reply](../topics/protocol.md#bulk-strings) elements representing ACL security events.",
Expand All @@ -47,12 +53,6 @@
"ACL WHOAMI": [
"[Bulk string reply](../topics/protocol.md#bulk-strings): the username of the current connection."
],
"ACL-LOAD": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` on success.",
"",
"The command may fail with an error for several reasons: if the file is not readable, if there is an error inside the file, and in such cases, the error will be reported to the user in the error.",
"Finally, the command will fail if the server is not configured to use an external ACL file."
],
"APPEND": [
"[Integer reply](../topics/protocol.md#integers): the length of the string after the append operation."
],
Expand Down Expand Up @@ -144,6 +144,9 @@
"CLIENT CACHING": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` or an error if the argument is not \"yes\" or \"no\"."
],
"CLIENT CAPA": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
],
"CLIENT GETNAME": [
"One of the following:",
"* [Bulk string reply](../topics/protocol.md#bulk-strings): the connection name of the current connection.",
Expand Down Expand Up @@ -229,7 +232,7 @@
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` if the command was successful. Otherwise an error is returned."
],
"CLUSTER FAILOVER": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` if the command was accepted and a manual failover is going to be attempted. An error if the operation cannot be executed, for example if the client is connected to a node that is already a master."
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` if the command was accepted and a manual failover is going to be attempted. An error if the operation cannot be executed, for example if the client is connected to a node that is already a primary."
],
"CLUSTER FLUSHSLOTS": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`"
Expand Down Expand Up @@ -265,7 +268,7 @@
"[Bulk string reply](../topics/protocol.md#bulk-strings): the serialized cluster configuration."
],
"CLUSTER REPLICAS": [
"[Array reply](../topics/protocol.md#arrays): a list of replica nodes replicating from the specified master node provided in the same format used by `CLUSTER NODES`."
"[Array reply](../topics/protocol.md#arrays): a list of replica nodes replicating from the specified primary node provided in the same format used by `CLUSTER NODES`."
],
"CLUSTER REPLICATE": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` if the command was successful. Otherwise an error is returned."
Expand All @@ -286,7 +289,7 @@
"[Array reply](../topics/protocol.md#arrays): a nested list of a map of hash ranges and shard nodes describing individual shards."
],
"CLUSTER SLAVES": [
"[Array reply](../topics/protocol.md#arrays): a list of replica nodes replicating from the specified master node provided in the same format used by `CLUSTER NODES`."
"[Array reply](../topics/protocol.md#arrays): a list of replica nodes replicating from the specified primary node provided in the same format used by `CLUSTER NODES`."
],
"CLUSTER SLOTS": [
"[Array reply](../topics/protocol.md#arrays): nested list of slot ranges with networking information."
Expand Down Expand Up @@ -578,7 +581,7 @@
"HSCAN": [
"[Array reply](../topics/protocol.md#arrays): a two-element array.",
"* The first element is a [Bulk string reply](../topics/protocol.md#bulk-strings) that represents an unsigned 64-bit number, the cursor.",
"* The second element is an [Array reply](../topics/protocol.md#arrays) of field/value pairs that were scanned."
"* The second element is an [Array reply](../topics/protocol.md#arrays) of field/value pairs that were scanned. When `NOVALUES` option is on, a list of keys from the hash."
],
"HSET": [
"[Integer reply](../topics/protocol.md#integers): the number of fields that were added."
Expand Down Expand Up @@ -835,7 +838,7 @@
"When successful, this command doesn't return anything. Instead, for each pattern, one message with the first element being the string `psubscribe` is pushed as a confirmation that the command succeeded."
],
"PSYNC": [
"**Non-standard return value**, a bulk transfer of the data followed by `PING` and write requests from the master."
"**Non-standard return value**, a bulk transfer of the data followed by `PING` and write requests from the primary."
],
"PTTL": [
"One of the following:",
Expand Down Expand Up @@ -958,6 +961,9 @@
"SCRIPT LOAD": [
"[Bulk string reply](../topics/protocol.md#bulk-strings): the SHA1 digest of the script added into the script cache."
],
"SCRIPT SHOW": [
"[Bulk string reply](../topics/protocol.md#bulk-strings): Lua script if sha1 hash exists in script cache."
],
"SDIFF": [
"[Array reply](../topics/protocol.md#arrays): a list with members of the resulting set."
],
Expand Down Expand Up @@ -1086,7 +1092,7 @@
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
],
"SYNC": [
"**Non-standard return value**, a bulk transfer of the data followed by `PING` and write requests from the master."
"**Non-standard return value**, a bulk transfer of the data followed by `PING` and write requests from the primary."
],
"TIME": [
"[Array reply](../topics/protocol.md#arrays): specifically, a two-element array consisting of the Unix timestamp in seconds and the microseconds' count."
Expand Down Expand Up @@ -1117,7 +1123,7 @@
],
"WAITAOF": [
"[Array reply](../topics/protocol.md#arrays): The command returns an array of two integers:",
"1. The first is the number of local Redises (0 or 1) that have fsynced to AOF all writes performed in the context of the current connection",
"1. The first is the number of local Valkey nodes (0 or 1) that have fsynced to AOF all writes performed in the context of the current connection",
"2. The second is the number of replicas that have acknowledged doing the same."
],
"WATCH": [
Expand Down Expand Up @@ -1307,7 +1313,9 @@
"* [Array reply](../topics/protocol.md#arrays): The rank and score of the member when _WITHSCORE_ is used."
],
"ZSCAN": [
"[Array reply](../topics/protocol.md#arrays): cursor and scan response in array form."
"[Array reply](../topics/protocol.md#arrays): a two-element array.",
"* The first element is a [Bulk string reply](../topics/protocol.md#bulk-strings) that represents an unsigned 64-bit number, the cursor.",
"* The second element is an [Array reply](../topics/protocol.md#arrays) of member/score pairs that were scanned. When `NOSCORES` option is on, a list of members from the sorted set."
],
"ZSCORE": [
"One of the following:",
Expand Down
46 changes: 27 additions & 19 deletions resp3_replies.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,9 @@
"CLIENT CACHING": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` or an error if the argument is not \"yes\" or \"no\"."
],
"CLIENT CAPA": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
],
"CLIENT GETNAME": [
"One of the following:",
"* [Bulk string reply](../topics/protocol.md#bulk-strings): the connection name of the current connection.",
Expand Down Expand Up @@ -229,7 +232,7 @@
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` if the command was successful. Otherwise an error is returned."
],
"CLUSTER FAILOVER": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` if the command was accepted and a manual failover is going to be attempted. An error if the operation cannot be executed, for example if the client is connected to a node that is already a master."
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` if the command was accepted and a manual failover is going to be attempted. An error if the operation cannot be executed, for example if the client is connected to a node that is already a primary."
],
"CLUSTER FLUSHSLOTS": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
Expand Down Expand Up @@ -265,7 +268,7 @@
"[Bulk string reply](../topics/protocol.md#bulk-strings): the serialized cluster configuration."
],
"CLUSTER REPLICAS": [
"[Array reply](../topics/protocol.md#arrays): a list of replica nodes replicating from the specified master node provided in the same format used by `CLUSTER NODES`."
"[Array reply](../topics/protocol.md#arrays): a list of replica nodes replicating from the specified primary node provided in the same format used by `CLUSTER NODES`."
],
"CLUSTER REPLICATE": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK` if the command was successful. Otherwise an error is returned."
Expand All @@ -286,7 +289,7 @@
"[Array reply](../topics/protocol.md#arrays): a nested list of [Map reply](../topics/protocol.md#maps) of hash ranges and shard nodes describing individual shards."
],
"CLUSTER SLAVES": [
"[Array reply](../topics/protocol.md#arrays): a list of replica nodes replicating from the specified master node provided in the same format used by `CLUSTER NODES`."
"[Array reply](../topics/protocol.md#arrays): a list of replica nodes replicating from the specified primary node provided in the same format used by `CLUSTER NODES`."
],
"CLUSTER SLOTS": [
"[Array reply](../topics/protocol.md#arrays): nested list of slot ranges with networking information."
Expand Down Expand Up @@ -578,7 +581,7 @@
"HSCAN": [
"[Array reply](../topics/protocol.md#arrays): a two-element array.",
"* The first element is a [Bulk string reply](../topics/protocol.md#bulk-strings) that represents an unsigned 64-bit number, the cursor.",
"* The second element is an [Array reply](../topics/protocol.md#arrays) of field/value pairs that were scanned."
"* The second element is an [Array reply](../topics/protocol.md#arrays) of field/value pairs that were scanned. When `NOVALUES` option is on, a list of keys from the hash."
],
"HSET": [
"[Integer reply](../topics/protocol.md#integers): the number of fields that were added."
Expand Down Expand Up @@ -835,7 +838,7 @@
"When successful, this command doesn't return anything. Instead, for each pattern, one message with the first element being the string `psubscribe` is pushed as a confirmation that the command succeeded."
],
"PSYNC": [
"**Non-standard return value**, a bulk transfer of the data followed by `PING` and write requests from the master."
"**Non-standard return value**, a bulk transfer of the data followed by `PING` and write requests from the primary."
],
"PTTL": [
"One of the following:",
Expand Down Expand Up @@ -958,6 +961,9 @@
"SCRIPT LOAD": [
"[Bulk string reply](../topics/protocol.md#bulk-strings): the SHA1 digest of the script added into the script cache."
],
"SCRIPT SHOW": [
"[Bulk string reply](../topics/protocol.md#bulk-strings): Lua script if sha1 hash exists in script cache."
],
"SDIFF": [
"[Set reply](../topics/protocol.md#sets): the resulting set."
],
Expand All @@ -968,7 +974,7 @@
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
],
"SENTINEL CKQUORUM": [
"[Bulk string reply](../topics/protocol.md#bulk-strings): Returns OK if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover."
"[Bulk string reply](../topics/protocol.md#bulk-strings): Returns OK if the current Sentinel configuration is able to reach the quorum needed to failover a primary, and the majority needed to authorize the failover."
],
"SENTINEL CONFIG": [
"One of the following:",
Expand All @@ -981,24 +987,24 @@
"* [Map reply](../topics/protocol.md#maps): List of configurable time parameters and their values (milliseconds)."
],
"SENTINEL FAILOVER": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`. Force a fail over as if the master was not reachable, and without asking for agreement to other Sentinels."
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`. Force a fail over as if the primary was not reachable, and without asking for agreement to other Sentinels."
],
"SENTINEL FLUSHCONFIG": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`. Force Sentinel to rewrite its configuration on disk, including the current Sentinel state."
],
"SENTINEL GET MASTER-ADDR-BY-NAME": [],
"SENTINEL GET PRIMARY-ADDR-BY-NAME": [],
"SENTINEL HELP": [
"[Array reply](../topics/protocol.md#arrays): Helpful text about subcommands."
],
"SENTINEL INFO CACHE": [
"[Array reply](../topics/protocol.md#arrays): This is actually a map, the odd entries are a master name, and the even entries are the last cached INFO output from that master and all its replicas."
"[Array reply](../topics/protocol.md#arrays): This is actually a map, the odd entries are a primary name, and the even entries are the last cached INFO output from that primary and all its replicas."
],
"SENTINEL IS MASTER-DOWN-BY-ADDR": [],
"SENTINEL MASTER": [
"[Map reply](../topics/protocol.md#maps): The state and info of the specified master."
"SENTINEL IS PRIMARY-DOWN-BY-ADDR": [],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both names exist for backward compatibility. We should probably duplicate these for both the primary and master subcommands.

Copy link
Contributor Author

@gmbnomis gmbnomis Dec 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just did "robotic" replacements here, but actually:

  1. The sentinel commands appear only in the resp3 file
  2. The sentinel command documentation lives outside of the regular command documentation anyway: https://valkey.io/topics/sentinel/#sentinel-api

I tend to remove the Sentinel commands from here. But I can also duplicate these both for master/primary and resp2/resp3 respectively if we intend to make the sentinel commands "first class citizens" in the future.

"SENTINEL PRIMARY": [
"[Map reply](../topics/protocol.md#maps): The state and info of the specified primary."
],
"SENTINEL MASTERS": [
"[Array reply](../topics/protocol.md#arrays): List of monitored Valkey masters, and their state."
"SENTINEL PRIMARIES": [
"[Array reply](../topics/protocol.md#arrays): List of monitored Valkey primaries, and their state."
],
"SENTINEL MONITOR": [
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
Expand All @@ -1013,10 +1019,10 @@
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
],
"SENTINEL REPLICAS": [
"[Array reply](../topics/protocol.md#arrays): List of replicas for this master, and their state."
"[Array reply](../topics/protocol.md#arrays): List of replicas for this primary, and their state."
],
"SENTINEL RESET": [
"[Integer reply](../topics/protocol.md#integers): The number of masters that were reset."
"[Integer reply](../topics/protocol.md#integers): The number of primaries that were reset."
],
"SENTINEL SENTINELS": [
"[Array reply](../topics/protocol.md#arrays): List of sentinel instances, and their state."
Expand Down Expand Up @@ -1151,7 +1157,7 @@
"[Simple string reply](../topics/protocol.md#simple-strings): `OK`."
],
"SYNC": [
"**Non-standard return value**, a bulk transfer of the data followed by `PING` and write requests from the master."
"**Non-standard return value**, a bulk transfer of the data followed by `PING` and write requests from the primary."
],
"TIME": [
"[Array reply](../topics/protocol.md#arrays): specifically, a two-element array consisting of the Unix timestamp in seconds and the microseconds' count."
Expand Down Expand Up @@ -1182,7 +1188,7 @@
],
"WAITAOF": [
"[Array reply](../topics/protocol.md#arrays): The command returns an array of two integers:",
"1. The first is the number of local Redises (0 or 1) that have fsynced to AOF all writes performed in the context of the current connection",
"1. The first is the number of local Valkey nodes (0 or 1) that have fsynced to AOF all writes performed in the context of the current connection",
"2. The second is the number of replicas that have acknowledged doing the same."
],
"WATCH": [
Expand Down Expand Up @@ -1372,7 +1378,9 @@
"* [Array reply](../topics/protocol.md#arrays): The rank and score of the member when _WITHSCORE_ is used."
],
"ZSCAN": [
"[Array reply](../topics/protocol.md#arrays): cursor and scan response in array form."
"[Array reply](../topics/protocol.md#arrays): a two-element array.",
"* The first element is a [Bulk string reply](../topics/protocol.md#bulk-strings) that represents an unsigned 64-bit number, the cursor.",
"* The second element is an [Array reply](../topics/protocol.md#arrays) of member/score pairs that were scanned. When `NOSCORES` option is on, a list of members from the sorted set."
],
"ZSCORE": [
"One of the following:",
Expand Down
Loading