From 068190a8029a47b5ce10b5f7f2a208d1e99a6f00 Mon Sep 17 00:00:00 2001 From: Yossi Gottlieb Date: Thu, 27 Jan 2022 21:48:06 +0200 Subject: [PATCH] Update generate-command-help.rb and help.h. (#10196) There are some inevitable changes between the old and new output, as a result of the different `commands.json` semantics. --- src/help.h | 566 ++++++++++++++++++++++++++++----- utils/generate-command-help.rb | 15 +- 2 files changed, 497 insertions(+), 84 deletions(-) diff --git a/src/help.h b/src/help.h index e7cd00391..f7bcd4337 100644 --- a/src/help.h +++ b/src/help.h @@ -1,4 +1,4 @@ -/* Automatically generated by ./utils/generate-command-help.rb, do not edit. */ +/* Automatically generated by utils/generate-command-help.rb, do not edit. */ #ifndef __REDIS_HELP_H #define __REDIS_HELP_H @@ -8,7 +8,7 @@ static char *commandGroups[] = { "string", "list", "set", - "sorted_set", + "sorted-set", "hash", "pubsub", "transactions", @@ -18,7 +18,8 @@ static char *commandGroups[] = { "hyperloglog", "cluster", "geo", - "stream" + "stream", + "bitmap" }; struct commandHelp { @@ -28,6 +29,11 @@ struct commandHelp { int group; char *since; } commandHelp[] = { + { "ACL", + "", + "A container for Access List Control commands ", + 9, + "6.0.0" }, { "ACL CAT", "[categoryname]", "List the ACL categories or the commands inside a category", @@ -64,7 +70,7 @@ struct commandHelp { 9, "6.0.0" }, { "ACL LOG", - "[count or RESET]", + "[count|RESET]", "List latest events denied because of ACLs in place", 9, "6.0.0" }, @@ -93,6 +99,11 @@ struct commandHelp { "Append a value to a key", 1, "2.0.0" }, + { "ASKING", + "", + "Sent by cluster clients after an -ASK redirect", + 12, + "3.0.0" }, { "AUTH", "[username] password", "Authenticate to the server", @@ -109,30 +120,40 @@ struct commandHelp { 9, "1.0.0" }, { "BITCOUNT", - "key [start end]", + "key [start end [BYTE|BIT]]", "Count set bits in a string", - 1, + 15, "2.6.0" }, { "BITFIELD", - "key [GET type offset] [SET type offset value] [INCRBY type offset increment] [OVERFLOW WRAP|SAT|FAIL]", + "key [GET encoding offset] [SET encoding offset value] [INCRBY encoding offset increment] [OVERFLOW WRAP|SAT|FAIL]", "Perform arbitrary bitfield integer operations on strings", - 1, + 15, "3.2.0" }, + { "BITFIELD_RO", + "key GET encoding offset", + "Perform arbitrary bitfield integer operations on strings. Read-only variant of BITFIELD", + 15, + "6.2.0" }, { "BITOP", "operation destkey key [key ...]", "Perform bitwise operations between strings", - 1, + 15, "2.6.0" }, { "BITPOS", - "key bit [start] [end]", + "key bit [start [end [BYTE|BIT]]]", "Find first bit set or clear in a string", - 1, + 15, "2.8.7" }, { "BLMOVE", "source destination LEFT|RIGHT LEFT|RIGHT timeout", "Pop an element from a list, push it to another list and return it; or block until one is available", 2, "6.2.0" }, + { "BLMPOP", + "timeout numkeys key [key ...] LEFT|RIGHT [COUNT count]", + "Pop elements from a list, or block until one is available", + 2, + "7.0.0" }, { "BLPOP", "key [key ...] timeout", "Remove and get the first element in a list, or block until one is available", @@ -148,6 +169,11 @@ struct commandHelp { "Pop an element from a list, push it to another list and return it; or block until one is available", 2, "2.2.0" }, + { "BZMPOP", + "timeout numkeys key [key ...] MIN|MAX [COUNT count]", + "Remove and return members with scores in a sorted set or block until one is available", + 4, + "7.0.0" }, { "BZPOPMAX", "key [key ...] timeout", "Remove and return the member with the highest score from one or more sorted sets, or block until one is available", @@ -158,6 +184,11 @@ struct commandHelp { "Remove and return the member with the lowest score from one or more sorted sets, or block until one is available", 4, "5.0.0" }, + { "CLIENT", + "", + "A container for client connection commands", + 8, + "2.4.0" }, { "CLIENT CACHING", "YES|NO", "Instruct the server about tracking or not keys in the next request", @@ -173,6 +204,11 @@ struct commandHelp { "Get tracking notifications redirection client ID if any", 8, "6.0.0" }, + { "CLIENT HELP", + "", + "Show helpful text about the different subcommands", + 8, + "5.0.0" }, { "CLIENT ID", "", "Returns the client ID for the current connection", @@ -184,15 +220,20 @@ struct commandHelp { 8, "6.2.0" }, { "CLIENT KILL", - "[ip:port] [ID client-id] [TYPE normal|master|slave|pubsub] [USER username] [ADDR ip:port] [LADDR ip:port] [SKIPME yes/no]", + "[ip:port] [ID client-id] [TYPE NORMAL|MASTER|SLAVE|REPLICA|PUBSUB] [USER username] [ADDR ip:port] [LADDR ip:port] [SKIPME yes/no]", "Kill the connection of a client", 8, "2.4.0" }, { "CLIENT LIST", - "[TYPE normal|master|replica|pubsub] [ID client-id [client-id ...]]", + "[TYPE NORMAL|MASTER|REPLICA|PUBSUB] [ID client-id [client-id ...]]", "Get the list of client connections", 8, "2.4.0" }, + { "CLIENT NO-EVICT", + "ON|OFF", + "Set client eviction mode for the current connection", + 8, + "7.0.0" }, { "CLIENT PAUSE", "timeout [WRITE|ALL]", "Stop processing commands from clients for some time", @@ -209,7 +250,7 @@ struct commandHelp { 8, "2.6.9" }, { "CLIENT TRACKING", - "ON|OFF [REDIRECT client-id] [PREFIX prefix [PREFIX prefix ...]] [BCAST] [OPTIN] [OPTOUT] [NOLOOP]", + "ON|OFF [REDIRECT client-id] [PREFIX prefix [prefix ...]] [BCAST] [OPTIN] [OPTOUT] [NOLOOP]", "Enable or disable server assisted client side caching support", 8, "6.0.0" }, @@ -228,11 +269,21 @@ struct commandHelp { "Resume processing of clients that were paused", 8, "6.2.0" }, + { "CLUSTER", + "", + "A container for cluster commands", + 12, + "3.0.0" }, { "CLUSTER ADDSLOTS", "slot [slot ...]", "Assign new hash slots to receiving node", 12, "3.0.0" }, + { "CLUSTER ADDSLOTSRANGE", + "start-slot end-slot [start-slot end-slot ...]", + "Assign new hash slots to receiving node", + 12, + "7.0.0" }, { "CLUSTER BUMPEPOCH", "", "Advance the cluster config epoch", @@ -253,6 +304,11 @@ struct commandHelp { "Set hash slots as unbound in receiving node", 12, "3.0.0" }, + { "CLUSTER DELSLOTSRANGE", + "start-slot end-slot [start-slot end-slot ...]", + "Set hash slots as unbound in receiving node", + 12, + "7.0.0" }, { "CLUSTER FAILOVER", "[FORCE|TAKEOVER]", "Forces a replica to perform a manual failover of its master.", @@ -273,6 +329,11 @@ struct commandHelp { "Return local key names in the specified hash slot", 12, "3.0.0" }, + { "CLUSTER HELP", + "", + "Show helpful text about the different subcommands", + 12, + "5.0.0" }, { "CLUSTER INFO", "", "Provides info about Redis Cluster node state", @@ -283,6 +344,11 @@ struct commandHelp { "Returns the hash slot of the specified key", 12, "3.0.0" }, + { "CLUSTER LINKS", + "", + "Returns a list of all TCP links to and from peer nodes in cluster", + 12, + "7.0.0" }, { "CLUSTER MEET", "ip port", "Force a node cluster to handshake with another node", @@ -324,7 +390,7 @@ struct commandHelp { 12, "3.0.0" }, { "CLUSTER SETSLOT", - "slot IMPORTING|MIGRATING|STABLE|NODE [node-id]", + "slot IMPORTING node-id|MIGRATING node-id|NODE node-id|STABLE", "Bind a hash slot to a specific node", 12, "3.0.0" }, @@ -348,21 +414,46 @@ struct commandHelp { "Get total number of Redis commands", 9, "2.8.13" }, + { "COMMAND DOCS", + "[command-name [command-name ...]]", + "Get array of specific Redis command documentation", + 9, + "7.0.0" }, { "COMMAND GETKEYS", "", "Extract keys given a full Redis command", 9, "2.8.13" }, + { "COMMAND HELP", + "", + "Show helpful text about the different subcommands", + 9, + "5.0.0" }, { "COMMAND INFO", - "command-name [command-name ...]", - "Get array of specific Redis command details", + "[command-name [command-name ...]]", + "Get array of specific Redis command details, or all when no argument is given.", 9, "2.8.13" }, - { "CONFIG GET", - "parameter", - "Get the value of a configuration parameter", + { "COMMAND LIST", + "[FILTERBY MODULE module-name|ACLCAT category|PATTERN pattern]", + "Get an array of Redis command names", + 9, + "7.0.0" }, + { "CONFIG", + "", + "A container for server configuration commands", 9, "2.0.0" }, + { "CONFIG GET", + "parameter [parameter ...]", + "Get the values of configuration parameters", + 9, + "2.0.0" }, + { "CONFIG HELP", + "", + "Show helpful text about the different subcommands", + 9, + "5.0.0" }, { "CONFIG RESETSTAT", "", "Reset the stats returned by INFO", @@ -374,8 +465,8 @@ struct commandHelp { 9, "2.8.0" }, { "CONFIG SET", - "parameter value", - "Set a configuration parameter to the given value", + "parameter value [parameter value ...]", + "Set configuration parameters to the given values", 9, "2.0.0" }, { "COPY", @@ -388,14 +479,9 @@ struct commandHelp { "Return the number of keys in the selected database", 9, "1.0.0" }, - { "DEBUG OBJECT", - "key", - "Get debugging information about a key", - 9, - "1.0.0" }, - { "DEBUG SEGFAULT", + { "DEBUG", "", - "Make the server crash", + "A container for debugging commands", 9, "1.0.0" }, { "DECR", @@ -429,15 +515,25 @@ struct commandHelp { 8, "1.0.0" }, { "EVAL", - "script numkeys key [key ...] arg [arg ...]", + "script numkeys [key [key ...]] [arg [arg ...]]", "Execute a Lua script server side", 10, "2.6.0" }, { "EVALSHA", - "sha1 numkeys key [key ...] arg [arg ...]", + "sha1 numkeys [key [key ...]] [arg [arg ...]]", "Execute a Lua script server side", 10, "2.6.0" }, + { "EVALSHA_RO", + "sha1 numkeys key [key ...] arg [arg ...]", + "Execute a read-only Lua script server side", + 10, + "7.0.0" }, + { "EVAL_RO", + "script numkeys key [key ...] arg [arg ...]", + "Execute a read-only Lua script server side", + 10, + "7.0.0" }, { "EXEC", "", "Execute all commands issued after MULTI", @@ -449,20 +545,35 @@ struct commandHelp { 0, "1.0.0" }, { "EXPIRE", - "key seconds", + "key seconds [NX|XX|GT|LT]", "Set a key's time to live in seconds", 0, "1.0.0" }, { "EXPIREAT", - "key timestamp", + "key timestamp [NX|XX|GT|LT]", "Set the expiration for a key as a UNIX timestamp", 0, "1.2.0" }, + { "EXPIRETIME", + "key", + "Get the expiration Unix timestamp for a key", + 0, + "7.0.0" }, { "FAILOVER", "[TO host port [FORCE]] [ABORT] [TIMEOUT milliseconds]", "Start a coordinated failover between this server and one of its replicas.", 9, "6.2.0" }, + { "FCALL", + "function numkeys key [key ...] arg [arg ...]", + "PATCH__TBD__38__", + 10, + "7.0.0" }, + { "FCALL_RO", + "function numkeys key [key ...] arg [arg ...]", + "PATCH__TBD__7__", + 10, + "7.0.0" }, { "FLUSHALL", "[ASYNC|SYNC]", "Remove all keys from all databases", @@ -473,13 +584,63 @@ struct commandHelp { "Remove all keys from the current database", 9, "1.0.0" }, + { "FUNCTION", + "", + "A container for function commands", + 10, + "7.0.0" }, + { "FUNCTION DELETE", + "function-name", + "Delete a function by name", + 10, + "7.0.0" }, + { "FUNCTION DUMP", + "", + "Dump all functions into a serialized binary payload", + 10, + "7.0.0" }, + { "FUNCTION FLUSH", + "[ASYNC|SYNC]", + "Deleting all functions", + 10, + "7.0.0" }, + { "FUNCTION HELP", + "", + "Show helpful text about the different subcommands", + 10, + "7.0.0" }, + { "FUNCTION KILL", + "", + "Kill the function currently in execution.", + 10, + "7.0.0" }, + { "FUNCTION LIST", + "[LIBRARYNAME library-name-pattern] [WITHCODE]", + "List information about all the functions", + 10, + "7.0.0" }, + { "FUNCTION LOAD", + "engine-name library-name [REPLACE] [DESC library-description] function-code", + "Create a function with the given arguments (name, code, description)", + 10, + "7.0.0" }, + { "FUNCTION RESTORE", + "serialized-value [FLUSH|APPEND|REPLACE]", + "Restore all the functions on the given payload", + 10, + "7.0.0" }, + { "FUNCTION STATS", + "", + "Return information about the function currently running (name, description, duration)", + 10, + "7.0.0" }, { "GEOADD", "key [NX|XX] [CH] longitude latitude member [longitude latitude member ...]", "Add one or more geospatial items in the geospatial index represented using a sorted set", 13, "3.2.0" }, { "GEODIST", - "key member1 member2 [m|km|ft|mi]", + "key member1 member2 [M|KM|FT|MI]", "Returns the distance between two members of a geospatial index", 13, "3.2.0" }, @@ -494,25 +655,35 @@ struct commandHelp { 13, "3.2.0" }, { "GEORADIUS", - "key longitude latitude radius m|km|ft|mi [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC|DESC] [STORE key] [STOREDIST key]", + "key longitude latitude radius M|KM|FT|MI [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC|DESC] [STORE key] [STOREDIST key]", "Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point", 13, "3.2.0" }, { "GEORADIUSBYMEMBER", - "key member radius m|km|ft|mi [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC|DESC] [STORE key] [STOREDIST key]", + "key member radius M|KM|FT|MI [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC|DESC] [STORE key] [STOREDIST key]", "Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member", 13, "3.2.0" }, + { "GEORADIUSBYMEMBER_RO", + "key member radius M|KM|FT|MI [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC|DESC]", + "A read-only variant for GEORADIUSBYMEMBER", + 13, + "3.2.10" }, + { "GEORADIUS_RO", + "key longitude latitude radius M|KM|FT|MI [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC|DESC]", + "A read-only variant for GEORADIUS", + 13, + "3.2.10" }, { "GEOSEARCH", - "key [FROMMEMBER member] [FROMLONLAT longitude latitude] [BYRADIUS radius m|km|ft|mi] [BYBOX width height m|km|ft|mi] [ASC|DESC] [COUNT count [ANY]] [WITHCOORD] [WITHDIST] [WITHHASH]", + "key [FROMMEMBER member] [FROMLONLAT longitude latitude] [BYRADIUS radius M|KM|FT|MI] [BYBOX width height M|KM|FT|MI] [ASC|DESC] [COUNT count [ANY]] [WITHCOORD] [WITHDIST] [WITHHASH]", "Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle.", 13, - "6.2" }, + "6.2.0" }, { "GEOSEARCHSTORE", - "destination source [FROMMEMBER member] [FROMLONLAT longitude latitude] [BYRADIUS radius m|km|ft|mi] [BYBOX width height m|km|ft|mi] [ASC|DESC] [COUNT count [ANY]] [STOREDIST]", + "destination source [FROMMEMBER member] [FROMLONLAT longitude latitude] [BYRADIUS radius M|KM|FT|MI] [BYBOX width height M|KM|FT|MI] [ASC|DESC] [COUNT count [ANY]] [STOREDIST]", "Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key.", 13, - "6.2" }, + "6.2.0" }, { "GET", "key", "Get the value of a key", @@ -521,7 +692,7 @@ struct commandHelp { { "GETBIT", "key offset", "Returns the bit value at offset in the string value stored at key", - 1, + 15, "2.2.0" }, { "GETDEL", "key", @@ -529,7 +700,7 @@ struct commandHelp { 1, "6.2.0" }, { "GETEX", - "key [EX seconds|PX milliseconds|EXAT timestamp|PXAT milliseconds-timestamp|PERSIST]", + "key [EX seconds|PX milliseconds|EXAT unix-time|PXAT unix-time|PERSIST]", "Get the value of a key and optionally set its expiration", 1, "6.2.0" }, @@ -658,6 +829,11 @@ struct commandHelp { "Get the UNIX time stamp of the last successful save to disk", 9, "1.0.0" }, + { "LATENCY", + "", + "A container for latency diagnostics commands", + 9, + "2.8.13" }, { "LATENCY DOCTOR", "", "Return a human readable latency analysis report.", @@ -673,6 +849,11 @@ struct commandHelp { "Show helpful text about the different subcommands.", 9, "2.8.13" }, + { "LATENCY HISTOGRAM", + "[command [command ...]]", + "Return the cumulative distribution of latencies of a subset of commands or all.", + 9, + "7.0.0" }, { "LATENCY HISTORY", "event", "Return timestamp-latency samples for the event.", @@ -688,6 +869,11 @@ struct commandHelp { "Reset latency data for one or more events.", 9, "2.8.13" }, + { "LCS", + "key1 key2 [LEN] [IDX] [MINMATCHLEN len] [WITHMATCHLEN]", + "Find longest common substring", + 1, + "7.0.0" }, { "LINDEX", "key index", "Get an element from a list by its index", @@ -708,6 +894,11 @@ struct commandHelp { "Pop an element from a list, push it to another list and return it", 2, "6.2.0" }, + { "LMPOP", + "numkeys key [key ...] LEFT|RIGHT [COUNT count]", + "Pop elements from a list", + 2, + "7.0.0" }, { "LOLWUT", "[VERSION version]", "Display some computer art and the Redis version", @@ -753,6 +944,11 @@ struct commandHelp { "Trim a list to the specified range", 2, "1.0.0" }, + { "MEMORY", + "", + "A container for memory diagnostics commands", + 9, + "4.0.0" }, { "MEMORY DOCTOR", "", "Outputs memory problems report", @@ -789,17 +985,27 @@ struct commandHelp { 1, "1.0.0" }, { "MIGRATE", - "host port key|"" destination-db timeout [COPY] [REPLACE] [AUTH password] [AUTH2 username password] [KEYS key]", + "host port key| destination-db timeout [COPY] [REPLACE] [AUTH password] [AUTH2 username password] [KEYS key [key ...]]", "Atomically transfer a key from a Redis instance to another one.", 0, "2.6.0" }, + { "MODULE", + "", + "A container for module commands", + 9, + "4.0.0" }, + { "MODULE HELP", + "", + "Show helpful text about the different subcommands", + 9, + "5.0.0" }, { "MODULE LIST", "", "List all modules loaded by the server", 9, "4.0.0" }, { "MODULE LOAD", - "path [arg]", + "path [arg [arg ...]]", "Load a module", 9, "4.0.0" }, @@ -834,8 +1040,33 @@ struct commandHelp { 7, "1.2.0" }, { "OBJECT", - "subcommand [arguments [arguments ...]]", - "Inspect the internals of Redis objects", + "", + "A container for object introspection commands", + 0, + "2.2.3" }, + { "OBJECT ENCODING", + "key", + "Inspect the internal encoding of a Redis object", + 0, + "2.2.3" }, + { "OBJECT FREQ", + "key", + "Get the logarithmic access frequency counter of a Redis object", + 0, + "4.0.0" }, + { "OBJECT HELP", + "", + "Show helpful text about the different subcommands", + 0, + "6.2.0" }, + { "OBJECT IDLETIME", + "key", + "Get the time since a Redis object was last accessed", + 0, + "2.2.3" }, + { "OBJECT REFCOUNT", + "key", + "Get the number of references to the value of the key", 0, "2.2.3" }, { "PERSIST", @@ -844,17 +1075,22 @@ struct commandHelp { 0, "2.2.0" }, { "PEXPIRE", - "key milliseconds", + "key milliseconds [NX|XX|GT|LT]", "Set a key's time to live in milliseconds", 0, "2.6.0" }, { "PEXPIREAT", - "key milliseconds-timestamp", + "key milliseconds-timestamp [NX|XX|GT|LT]", "Set the expiration for a key as a UNIX timestamp specified in milliseconds", 0, "2.6.0" }, + { "PEXPIRETIME", + "key", + "Get the expiration Unix timestamp for a key in milliseconds", + 0, + "7.0.0" }, { "PFADD", - "key element [element ...]", + "key [element [element ...]]", "Adds the specified elements to the specified HyperLogLog.", 11, "2.8.9" }, @@ -863,11 +1099,21 @@ struct commandHelp { "Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).", 11, "2.8.9" }, + { "PFDEBUG", + "", + "Internal commands for debugging HyperLogLog values", + 11, + "2.8.9" }, { "PFMERGE", "destkey sourcekey [sourcekey ...]", "Merge N different HyperLogLogs into a single one.", 11, "2.8.9" }, + { "PFSELFTEST", + "", + "An internal command for testing HyperLogLog values", + 11, + "2.8.9" }, { "PING", "[message]", "Ping the server", @@ -899,10 +1145,40 @@ struct commandHelp { 6, "2.0.0" }, { "PUBSUB", - "subcommand [argument [argument ...]]", - "Inspect the state of the Pub/Sub subsystem", + "", + "A container for Pub/Sub commands", 6, "2.8.0" }, + { "PUBSUB CHANNELS", + "[pattern]", + "List active channels", + 6, + "2.8.0" }, + { "PUBSUB HELP", + "", + "Show helpful text about the different subcommands", + 6, + "6.2.0" }, + { "PUBSUB NUMPAT", + "", + "Get the count of unique patterns pattern subscriptions", + 6, + "2.8.0" }, + { "PUBSUB NUMSUB", + "[channel [channel ...]]", + "Get the count of subscribers for channels", + 6, + "2.8.0" }, + { "PUBSUB SHARDCHANNELS", + "[pattern]", + "List active shard channels", + 6, + "7.0.0" }, + { "PUBSUB SHARDNUMSUB", + "", + "Get the count of subscribers for shard channels", + 6, + "7.0.0" }, { "PUNSUBSCRIBE", "[pattern [pattern ...]]", "Stop listening for messages posted to channels matching the given patterns", @@ -938,6 +1214,11 @@ struct commandHelp { "Rename a key, only if the new key does not exist", 0, "1.0.0" }, + { "REPLCONF", + "", + "An internal command for configuring the replication stream", + 9, + "3.0.0" }, { "REPLICAOF", "host port", "Make the server a replica of another instance, or promote it as master.", @@ -947,12 +1228,17 @@ struct commandHelp { "", "Reset the connection", 8, - "6.2" }, + "6.2.0" }, { "RESTORE", "key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]", "Create a key using the provided serialized value, previously obtained using DUMP.", 0, "2.6.0" }, + { "RESTORE-ASKING", + "", + "An internal command for migrating keys in a cluster", + 9, + "3.0.0" }, { "ROLE", "", "Return the role of the instance in the context of replication", @@ -998,6 +1284,11 @@ struct commandHelp { "Get the number of members in a set", 3, "1.0.0" }, + { "SCRIPT", + "", + "A container for Lua scripts management commands", + 10, + "2.6.0" }, { "SCRIPT DEBUG", "YES|SYNC|NO", "Set the debug mode for executed scripts.", @@ -1013,6 +1304,11 @@ struct commandHelp { "Remove all the scripts from the script cache.", 10, "2.6.0" }, + { "SCRIPT HELP", + "", + "Show helpful text about the different subcommands", + 10, + "5.0.0" }, { "SCRIPT KILL", "", "Kill the script currently in execution.", @@ -1039,14 +1335,14 @@ struct commandHelp { 8, "1.0.0" }, { "SET", - "key value [EX seconds|PX milliseconds|EXAT timestamp|PXAT milliseconds-timestamp|KEEPTTL] [NX|XX] [GET]", + "key value [EX seconds|PX milliseconds|EXAT unix-time-seconds|PXAT unix-time-milliseconds|KEEPTTL] [NX|XX] [GET]", "Set the string value of a key", 1, "1.0.0" }, { "SETBIT", "key offset value", "Sets or clears the bit at offset in the string value stored at key", - 1, + 15, "2.2.0" }, { "SETEX", "key seconds value", @@ -1064,7 +1360,7 @@ struct commandHelp { 1, "2.2.0" }, { "SHUTDOWN", - "[NOSAVE|SAVE]", + "[NOSAVE|SAVE] [NOW] [FORCE] [ABORT]", "Synchronously save the dataset to disk and then shut down the server", 9, "1.0.0" }, @@ -1073,6 +1369,11 @@ struct commandHelp { "Intersect multiple sets", 3, "1.0.0" }, + { "SINTERCARD", + "numkeys key [key ...] [LIMIT limit]", + "Intersect multiple sets and return the cardinality of the result", + 3, + "7.0.0" }, { "SINTERSTORE", "destination key [key ...]", "Intersect multiple sets and store the resulting set in a key", @@ -1089,8 +1390,28 @@ struct commandHelp { 9, "1.0.0" }, { "SLOWLOG", - "subcommand [argument]", - "Manages the Redis slow queries log", + "", + "A container for slow log commands", + 9, + "2.2.12" }, + { "SLOWLOG GET", + "[count]", + "Get the slow log's entries", + 9, + "2.2.12" }, + { "SLOWLOG HELP", + "", + "Show helpful text about the different subcommands", + 9, + "6.2.0" }, + { "SLOWLOG LEN", + "", + "Get the slow log's length", + 9, + "2.2.12" }, + { "SLOWLOG RESET", + "", + "Clear all entries from the slow log", 9, "2.2.12" }, { "SMEMBERS", @@ -1109,15 +1430,25 @@ struct commandHelp { 3, "1.0.0" }, { "SORT", - "key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC|DESC] [ALPHA] [STORE destination]", + "key [BY pattern] [LIMIT offset count] [GET pattern [pattern ...]] [ASC|DESC] [ALPHA] [STORE destination]", "Sort the elements in a list, set or sorted set", 0, "1.0.0" }, + { "SORT_RO", + "key [BY pattern] [LIMIT offset count] [GET pattern [pattern ...]] [ASC|DESC] [ALPHA]", + "Sort the elements in a list, set or sorted set. Read-only variant of SORT.", + 0, + "7.0.0" }, { "SPOP", "key [count]", "Remove and return one or multiple random members from a set", 3, "1.0.0" }, + { "SPUBLISH", + "channel message", + "Post a message to a shard channel", + 6, + "7.0.0" }, { "SRANDMEMBER", "key [count]", "Get one or multiple random members from a set", @@ -1133,11 +1464,11 @@ struct commandHelp { "Incrementally iterate Set elements", 3, "2.8.0" }, - { "STRALGO", - "LCS algo-specific-argument [algo-specific-argument ...]", - "Run algorithms (currently LCS) against strings", - 1, - "6.0.0" }, + { "SSUBSCRIBE", + "channel [channel ...]", + "Listen for messages published to the given shard channels", + 6, + "7.0.0" }, { "STRLEN", "key", "Get the length of the value stored in a key", @@ -1148,6 +1479,11 @@ struct commandHelp { "Listen for messages published to the given channels", 6, "2.0.0" }, + { "SUBSTR", + "key start end", + "Get a substring of the string stored at a key", + 1, + "1.0.0" }, { "SUNION", "key [key ...]", "Add multiple sets", @@ -1158,6 +1494,11 @@ struct commandHelp { "Add multiple sets and store the resulting set in a key", 3, "1.0.0" }, + { "SUNSUBSCRIBE", + "[channel [channel ...]]", + "Stop listening for messages posted to the given shard channels", + 6, + "7.0.0" }, { "SWAPDB", "index1 index2", "Swaps two Redis databases", @@ -1180,7 +1521,7 @@ struct commandHelp { "3.2.1" }, { "TTL", "key", - "Get the time to live for a key", + "Get the time to live for a key in seconds", 0, "1.0.0" }, { "TYPE", @@ -1214,38 +1555,88 @@ struct commandHelp { 7, "2.2.0" }, { "XACK", - "key group ID [ID ...]", + "key group id [id ...]", "Marks a pending message as correctly processed, effectively removing it from the pending entries list of the consumer group. Return value of the command is the number of messages successfully acknowledged, that is, the IDs we were actually able to resolve in the PEL.", 14, "5.0.0" }, { "XADD", - "key [NOMKSTREAM] [MAXLEN|MINID [=|~] threshold [LIMIT count]] *|ID field value [field value ...]", + "key [NOMKSTREAM] [MAXLEN|MINID [=|~] threshold [LIMIT count]] *|id field value [field value ...]", "Appends a new entry to a stream", 14, "5.0.0" }, { "XAUTOCLAIM", - "key group consumer min-idle-time start [COUNT count] [justid]", + "key group consumer min-idle-time start [COUNT count] [JUSTID]", "Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer.", 14, "6.2.0" }, { "XCLAIM", - "key group consumer min-idle-time ID [ID ...] [IDLE ms] [TIME ms-unix-time] [RETRYCOUNT count] [force] [justid]", + "key group consumer min-idle-time id [id ...] [IDLE ms] [TIME ms-unix-time] [RETRYCOUNT count] [FORCE] [JUSTID]", "Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer.", 14, "5.0.0" }, { "XDEL", - "key ID [ID ...]", + "key id [id ...]", "Removes the specified entries from the stream. Returns the number of items actually deleted, that may be different from the number of IDs passed in case certain IDs do not exist.", 14, "5.0.0" }, { "XGROUP", - "[CREATE key groupname ID|$ [MKSTREAM]] [SETID key groupname ID|$] [DESTROY key groupname] [CREATECONSUMER key groupname consumername] [DELCONSUMER key groupname consumername]", - "Create, destroy, and manage consumer groups.", + "", + "A container for consumer groups commands", + 14, + "5.0.0" }, + { "XGROUP CREATE", + "key groupname id|$ [MKSTREAM]", + "Create a consumer group.", + 14, + "5.0.0" }, + { "XGROUP CREATECONSUMER", + "key groupname consumername", + "Create a consumer in a consumer group.", + 14, + "6.2.0" }, + { "XGROUP DELCONSUMER", + "key groupname consumername", + "Delete a consumer from a consumer group.", + 14, + "5.0.0" }, + { "XGROUP DESTROY", + "key groupname", + "Destroy a consumer group.", + 14, + "5.0.0" }, + { "XGROUP HELP", + "", + "Show helpful text about the different subcommands", + 14, + "5.0.0" }, + { "XGROUP SETID", + "key groupname id|$", + "Set a consumer group to an arbitrary last delivered ID value.", 14, "5.0.0" }, { "XINFO", - "[CONSUMERS key groupname] [GROUPS key] [STREAM key] [HELP]", - "Get information on streams and consumer groups", + "", + "A container for stream introspection commands", + 14, + "5.0.0" }, + { "XINFO CONSUMERS", + "key groupname", + "List the consumers in a consumer group", + 14, + "5.0.0" }, + { "XINFO GROUPS", + "key", + "List the consumer groups of a stream", + 14, + "5.0.0" }, + { "XINFO HELP", + "", + "Show helpful text about the different subcommands", + 14, + "5.0.0" }, + { "XINFO STREAM", + "key [FULL [COUNT count]]", + "Get information about a stream", 14, "5.0.0" }, { "XLEN", @@ -1264,12 +1655,12 @@ struct commandHelp { 14, "5.0.0" }, { "XREAD", - "[COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]", + "[COUNT count] [BLOCK milliseconds] STREAMS key [key ...] id [id ...]", "Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.", 14, "5.0.0" }, { "XREADGROUP", - "GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] ID [ID ...]", + "GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] id [id ...]", "Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block.", 14, "5.0.0" }, @@ -1278,6 +1669,11 @@ struct commandHelp { "Return a range of elements in a stream, with IDs matching the specified IDs interval, in reverse order (from greater to smaller IDs) compared to XRANGE", 14, "5.0.0" }, + { "XSETID", + "key last-id", + "An internal command for replicating stream values", + 14, + "5.0.0" }, { "XTRIM", "key MAXLEN|MINID [=|~] threshold [LIMIT count]", "Trims the stream to (approximately if '~' is passed) a certain size", @@ -1314,12 +1710,17 @@ struct commandHelp { 4, "1.2.0" }, { "ZINTER", - "numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX] [WITHSCORES]", + "numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX] [WITHSCORES]", "Intersect multiple sorted sets", 4, "6.2.0" }, + { "ZINTERCARD", + "numkeys key [key ...] [LIMIT limit]", + "Intersect multiple sorted sets and return the cardinality of the result", + 4, + "7.0.0" }, { "ZINTERSTORE", - "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]", + "destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX]", "Intersect multiple sorted sets and store the resulting sorted set in a new key", 4, "2.0.0" }, @@ -1328,6 +1729,11 @@ struct commandHelp { "Count the number of members in a sorted set between a given lexicographical range", 4, "2.8.9" }, + { "ZMPOP", + "numkeys key [key ...] MIN|MAX [COUNT count]", + "Remove and return members with scores in a sorted set", + 4, + "7.0.0" }, { "ZMSCORE", "key member [member ...]", "Get the score associated with the given members in a sorted set", @@ -1349,7 +1755,7 @@ struct commandHelp { 4, "6.2.0" }, { "ZRANGE", - "key min max [BYSCORE|BYLEX] [REV] [LIMIT offset count] [WITHSCORES]", + "key start stop [BYSCORE|BYLEX] [REV] [LIMIT offset count] [WITHSCORES]", "Return a range of members in a sorted set", 4, "1.2.0" }, @@ -1424,12 +1830,12 @@ struct commandHelp { 4, "1.2.0" }, { "ZUNION", - "numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX] [WITHSCORES]", + "numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX] [WITHSCORES]", "Add multiple sorted sets", 4, "6.2.0" }, { "ZUNIONSTORE", - "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]", + "destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX]", "Add multiple sorted sets and store the resulting sorted set in a new key", 4, "2.0.0" } diff --git a/utils/generate-command-help.rb b/utils/generate-command-help.rb index 003a593bd..482a3b9f8 100755 --- a/utils/generate-command-help.rb +++ b/utils/generate-command-help.rb @@ -5,7 +5,7 @@ GROUPS = [ "string", "list", "set", - "sorted_set", + "sorted-set", "hash", "pubsub", "transactions", @@ -27,17 +27,24 @@ GROUPS_BY_NAME = Hash[* def argument arg if "block" == arg["type"] - name = arg["block"].map do |entry| + name = arg["arguments"].map do |entry| argument entry end.join " " + elsif "oneof" == arg["type"] + name = arg["arguments"].map do |entry| + argument entry + end.join "|" + elsif "pure-token" == arg["type"] + name = nil # prepended later else name = arg["name"].is_a?(Array) ? arg["name"].join(" ") : arg["name"] - name = arg["enum"].join "|" if "enum" == arg["type"] - name = arg["command"] + (name ? " " + name : "") if arg["command"] end if arg["multiple"] name = "#{name} [#{name} ...]" end + if arg["token"] + name = [arg["token"], name].compact.join " " + end if arg["optional"] name = "[#{name}]" end