diff --git a/src/help.h b/src/help.h index 8a12458e1..b8b1efb95 100644 --- a/src/help.h +++ b/src/help.h @@ -1,4 +1,4 @@ -/* Automatically generated by 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 @@ -94,7 +94,7 @@ struct commandHelp { 1, "2.0.0" }, { "AUTH", - "password", + "[username] password", "Authenticate to the server", 8, "1.0.0" }, @@ -128,6 +128,11 @@ struct commandHelp { "Find first bit set or clear in a string", 1, "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" }, { "BLPOP", "key [key ...] timeout", "Remove and get the first element in a list, or block until one is available", @@ -173,18 +178,23 @@ struct commandHelp { "Returns the client ID for the current connection", 8, "5.0.0" }, + { "CLIENT INFO", + "-", + "Returns information about the current client connection.", + 8, + "6.2.0" }, { "CLIENT KILL", "[ip:port] [ID client-id] [TYPE normal|master|slave|pubsub] [USER username] [ADDR ip:port] [SKIPME yes/no]", "Kill the connection of a client", 8, "2.4.0" }, { "CLIENT LIST", - "[TYPE normal|master|replica|pubsub]", + "[TYPE normal|master|replica|pubsub] [ID client-id [client-id ...]]", "Get the list of client connections", 8, "2.4.0" }, { "CLIENT PAUSE", - "timeout", + "timeout [WRITE|ALL]", "Stop processing commands from clients for some time", 8, "2.9.50" }, @@ -203,11 +213,21 @@ struct commandHelp { "Enable or disable server assisted client side caching support", 8, "6.0.0" }, + { "CLIENT TRACKINGINFO", + "-", + "Return information about server assisted client side caching for the current connection", + 8, + "6.2.0" }, { "CLIENT UNBLOCK", "client-id [TIMEOUT|ERROR]", "Unblock a client blocked in a blocking command from a different connection", 8, "5.0.0" }, + { "CLIENT UNPAUSE", + "-", + "Resume processing of clients that were paused", + 8, + "6.2.0" }, { "CLUSTER ADDSLOTS", "slot [slot ...]", "Assign new hash slots to receiving node", @@ -358,6 +378,11 @@ struct commandHelp { "Set a configuration parameter to the given value", 9, "2.0.0" }, + { "COPY", + "source destination [DB destination-db] [REPLACE]", + "Copy a key", + 0, + "6.2.0" }, { "DBSIZE", "-", "Return the number of keys in the selected database", @@ -434,17 +459,17 @@ struct commandHelp { 0, "1.2.0" }, { "FLUSHALL", - "[ASYNC]", + "[ASYNC|SYNC]", "Remove all keys from all databases", 9, "1.0.0" }, { "FLUSHDB", - "[ASYNC]", + "[ASYNC|SYNC]", "Remove all keys from the current database", 9, "1.0.0" }, { "GEOADD", - "key longitude latitude member [longitude latitude member ...]", + "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" }, @@ -464,15 +489,25 @@ struct commandHelp { 13, "3.2.0" }, { "GEORADIUS", - "key longitude latitude radius m|km|ft|mi [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count] [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] [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" }, + { "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]", + "Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle.", + 13, + "6.2" }, + { "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]] [WITHCOORD] [WITHDIST] [WITHHASH] [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" }, { "GET", "key", "Get the value of a key", @@ -483,6 +518,16 @@ struct commandHelp { "Returns the bit value at offset in the string value stored at key", 1, "2.2.0" }, + { "GETDEL", + "key", + "Get the value of a key and delete the key", + 1, + "6.2.0" }, + { "GETEX", + "key [EX seconds|PX milliseconds|EXAT timestamp|PXAT milliseconds-timestamp|PERSIST]", + "Get the value of a key and optionally set its expiration", + 1, + "6.2.0" }, { "GETRANGE", "key start end", "Get a substring of the string stored at a key", @@ -499,8 +544,8 @@ struct commandHelp { 5, "2.0.0" }, { "HELLO", - "protover [AUTH username password] [SETNAME clientname]", - "switch Redis protocol", + "[protover [AUTH username password] [SETNAME clientname]]", + "Handshake with Redis", 8, "6.0.0" }, { "HEXISTS", @@ -548,6 +593,11 @@ struct commandHelp { "Set multiple hash fields to multiple values", 5, "2.0.0" }, + { "HRANDFIELD", + "key [count [WITHVALUES]]", + "Get one or multiple random fields from a hash", + 5, + "6.2.0" }, { "HSCAN", "key cursor [MATCH pattern] [COUNT count]", "Incrementally iterate hash fields and associated values", @@ -648,18 +698,23 @@ struct commandHelp { "Get the length of a list", 2, "1.0.0" }, + { "LMOVE", + "source destination LEFT|RIGHT LEFT|RIGHT", + "Pop an element from a list, push it to another list and return it", + 2, + "6.2.0" }, { "LOLWUT", "[VERSION version]", "Display some computer art and the Redis version", 9, "5.0.0" }, { "LPOP", - "key", - "Remove and get the first element in a list", + "key [count]", + "Remove and get the first elements in a list", 2, "1.0.0" }, { "LPOS", - "key element [FIRST rank] [COUNT num-matches] [MAXLEN len]", + "key element [RANK rank] [COUNT num-matches] [MAXLEN len]", "Return the index of matching elements on a list", 2, "6.0.6" }, @@ -729,7 +784,7 @@ struct commandHelp { 1, "1.0.0" }, { "MIGRATE", - "host port key|"" destination-db timeout [COPY] [REPLACE] [AUTH password] [KEYS key]", + "host port key|"" destination-db timeout [COPY] [REPLACE] [AUTH password] [AUTH2 username password] [KEYS key]", "Atomically transfer a key from a Redis instance to another one.", 0, "2.6.0" }, @@ -883,6 +938,11 @@ struct commandHelp { "Make the server a replica of another instance, or promote it as master.", 9, "5.0.0" }, + { "RESET", + "-", + "Reset the connection", + 8, + "6.2" }, { "RESTORE", "key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]", "Create a key using the provided serialized value, previously obtained using DUMP.", @@ -894,8 +954,8 @@ struct commandHelp { 9, "2.8.12" }, { "RPOP", - "key", - "Remove and get the last element in a list", + "key [count]", + "Remove and get the last elements in a list", 2, "1.0.0" }, { "RPOPLPUSH", @@ -944,7 +1004,7 @@ struct commandHelp { 10, "2.6.0" }, { "SCRIPT FLUSH", - "-", + "[ASYNC|SYNC]", "Remove all the scripts from the script cache.", 10, "2.6.0" }, @@ -974,7 +1034,7 @@ struct commandHelp { 8, "1.0.0" }, { "SET", - "key value [EX seconds|PX milliseconds] [NX|XX] [KEEPTTL]", + "key value [EX seconds|PX milliseconds|EXAT timestamp|PXAT milliseconds-timestamp|KEEPTTL] [NX|XX] [GET]", "Set the string value of a key", 1, "1.0.0" }, @@ -1033,6 +1093,11 @@ struct commandHelp { "Get all the members in a set", 3, "1.0.0" }, + { "SMISMEMBER", + "key member [member ...]", + "Returns the membership associated with the given elements for a set", + 3, + "6.2.0" }, { "SMOVE", "source destination member", "Move a member from one set to another", @@ -1149,10 +1214,15 @@ struct commandHelp { 14, "5.0.0" }, { "XADD", - "key 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]", + "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]", "Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer.", @@ -1164,7 +1234,7 @@ struct commandHelp { 14, "5.0.0" }, { "XGROUP", - "[CREATE key groupname id-or-$] [SETID key groupname id-or-$] [DESTROY key groupname] [DELCONSUMER key groupname consumername]", + "[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.", 14, "5.0.0" }, @@ -1179,7 +1249,7 @@ struct commandHelp { 14, "5.0.0" }, { "XPENDING", - "key group [start end count] [consumer]", + "key group [[IDLE min-idle-time] start end count [consumer]]", "Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged.", 14, "5.0.0" }, @@ -1189,7 +1259,7 @@ 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" }, @@ -1204,12 +1274,12 @@ struct commandHelp { 14, "5.0.0" }, { "XTRIM", - "key MAXLEN [~] count", + "key MAXLEN|MINID [=|~] threshold [LIMIT count]", "Trims the stream to (approximately if '~' is passed) a certain size", 14, "5.0.0" }, { "ZADD", - "key [NX|XX] [CH] [INCR] score member [score member ...]", + "key [NX|XX] [GT|LT] [CH] [INCR] score member [score member ...]", "Add one or more members to a sorted set, or update its score if it already exists", 4, "1.2.0" }, @@ -1223,11 +1293,26 @@ struct commandHelp { "Count the members in a sorted set with scores within the given values", 4, "2.0.0" }, + { "ZDIFF", + "numkeys key [key ...] [WITHSCORES]", + "Subtract multiple sorted sets", + 4, + "6.2.0" }, + { "ZDIFFSTORE", + "destination numkeys key [key ...]", + "Subtract multiple sorted sets and store the resulting sorted set in a new key", + 4, + "6.2.0" }, { "ZINCRBY", "key increment member", "Increment the score of a member in a sorted set", 4, "1.2.0" }, + { "ZINTER", + "numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX] [WITHSCORES]", + "Intersect multiple sorted sets", + 4, + "6.2.0" }, { "ZINTERSTORE", "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]", "Intersect multiple sorted sets and store the resulting sorted set in a new key", @@ -1238,6 +1323,11 @@ struct commandHelp { "Count the number of members in a sorted set between a given lexicographical range", 4, "2.8.9" }, + { "ZMSCORE", + "key member [member ...]", + "Get the score associated with the given members in a sorted set", + 4, + "6.2.0" }, { "ZPOPMAX", "key [count]", "Remove and return members with the highest scores in a sorted set", @@ -1248,9 +1338,14 @@ struct commandHelp { "Remove and return members with the lowest scores in a sorted set", 4, "5.0.0" }, + { "ZRANDMEMBER", + "key [count [WITHSCORES]]", + "Get one or multiple random elements from a sorted set", + 4, + "6.2.0" }, { "ZRANGE", - "key start stop [WITHSCORES]", - "Return a range of members in a sorted set, by index", + "key min max [BYSCORE|BYLEX] [REV] [LIMIT offset count] [WITHSCORES]", + "Return a range of members in a sorted set", 4, "1.2.0" }, { "ZRANGEBYLEX", @@ -1263,6 +1358,11 @@ struct commandHelp { "Return a range of members in a sorted set, by score", 4, "1.0.5" }, + { "ZRANGESTORE", + "dst src min max [BYSCORE|BYLEX] [REV] [LIMIT offset count]", + "Store a range of members from sorted set into another key", + 4, + "6.2.0" }, { "ZRANK", "key member", "Determine the index of a member in a sorted set", @@ -1318,6 +1418,11 @@ struct commandHelp { "Get the score associated with the given member in a sorted set", 4, "1.2.0" }, + { "ZUNION", + "numkeys key [key ...] [WEIGHTS 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]", "Add multiple sorted sets and store the resulting sorted set in a new key",