xref: /redis-3.2.3/src/help.h (revision edd7eb9b) 
1 /* Automatically generated by utils/generate-command-help.rb, do not edit. */
2 
3 #ifndef __REDIS_HELP_H
4 #define __REDIS_HELP_H
5 
6 static char *commandGroups[] = {
7     "generic",
8     "string",
9     "list",
10     "set",
11     "sorted_set",
12     "hash",
13     "pubsub",
14     "transactions",
15     "connection",
16     "server",
17     "scripting"
18 };
19 
20 struct commandHelp {
21   char *name;
22   char *params;
23   char *summary;
24   int group;
25   char *since;
26 } commandHelp[] = {
27     { "APPEND",
28     "key value",
29     "Append a value to a key",
30     1,
31     "2.0.0" },
32     { "AUTH",
33     "password",
34     "Authenticate to the server",
35     8,
36     "1.0.0" },
37     { "BGREWRITEAOF",
38     "-",
39     "Asynchronously rewrite the append-only file",
40     9,
41     "1.0.0" },
42     { "BGSAVE",
43     "-",
44     "Asynchronously save the dataset to disk",
45     9,
46     "1.0.0" },
47     { "BITCOUNT",
48     "key [start] [end]",
49     "Count set bits in a string",
50     1,
51     "2.6.0" },
52     { "BITOP",
53     "operation destkey key [key ...]",
54     "Perform bitwise operations between strings",
55     1,
56     "2.6.0" },
57     { "BLPOP",
58     "key [key ...] timeout",
59     "Remove and get the first element in a list, or block until one is available",
60     2,
61     "2.0.0" },
62     { "BRPOP",
63     "key [key ...] timeout",
64     "Remove and get the last element in a list, or block until one is available",
65     2,
66     "2.0.0" },
67     { "BRPOPLPUSH",
68     "source destination timeout",
69     "Pop a value from a list, push it to another list and return it; or block until one is available",
70     2,
71     "2.2.0" },
72     { "CLIENT GETNAME",
73     "-",
74     "Get the current connection name",
75     9,
76     "2.6.9" },
77     { "CLIENT KILL",
78     "ip:port",
79     "Kill the connection of a client",
80     9,
81     "2.4.0" },
82     { "CLIENT LIST",
83     "-",
84     "Get the list of client connections",
85     9,
86     "2.4.0" },
87     { "CLIENT SETNAME",
88     "connection-name",
89     "Set the current connection name",
90     9,
91     "2.6.9" },
92     { "CONFIG GET",
93     "parameter",
94     "Get the value of a configuration parameter",
95     9,
96     "2.0.0" },
97     { "CONFIG RESETSTAT",
98     "-",
99     "Reset the stats returned by INFO",
100     9,
101     "2.0.0" },
102     { "CONFIG SET",
103     "parameter value",
104     "Set a configuration parameter to the given value",
105     9,
106     "2.0.0" },
107     { "DBSIZE",
108     "-",
109     "Return the number of keys in the selected database",
110     9,
111     "1.0.0" },
112     { "DEBUG OBJECT",
113     "key",
114     "Get debugging information about a key",
115     9,
116     "1.0.0" },
117     { "DEBUG SEGFAULT",
118     "-",
119     "Make the server crash",
120     9,
121     "1.0.0" },
122     { "DECR",
123     "key",
124     "Decrement the integer value of a key by one",
125     1,
126     "1.0.0" },
127     { "DECRBY",
128     "key decrement",
129     "Decrement the integer value of a key by the given number",
130     1,
131     "1.0.0" },
132     { "DEL",
133     "key [key ...]",
134     "Delete a key",
135     0,
136     "1.0.0" },
137     { "DISCARD",
138     "-",
139     "Discard all commands issued after MULTI",
140     7,
141     "2.0.0" },
142     { "DUMP",
143     "key",
144     "Return a serialized version of the value stored at the specified key.",
145     0,
146     "2.6.0" },
147     { "ECHO",
148     "message",
149     "Echo the given string",
150     8,
151     "1.0.0" },
152     { "EVAL",
153     "script numkeys key [key ...] arg [arg ...]",
154     "Execute a Lua script server side",
155     10,
156     "2.6.0" },
157     { "EVALSHA",
158     "sha1 numkeys key [key ...] arg [arg ...]",
159     "Execute a Lua script server side",
160     10,
161     "2.6.0" },
162     { "EXEC",
163     "-",
164     "Execute all commands issued after MULTI",
165     7,
166     "1.2.0" },
167     { "EXISTS",
168     "key",
169     "Determine if a key exists",
170     0,
171     "1.0.0" },
172     { "EXPIRE",
173     "key seconds",
174     "Set a key's time to live in seconds",
175     0,
176     "1.0.0" },
177     { "EXPIREAT",
178     "key timestamp",
179     "Set the expiration for a key as a UNIX timestamp",
180     0,
181     "1.2.0" },
182     { "FLUSHALL",
183     "-",
184     "Remove all keys from all databases",
185     9,
186     "1.0.0" },
187     { "FLUSHDB",
188     "-",
189     "Remove all keys from the current database",
190     9,
191     "1.0.0" },
192     { "GET",
193     "key",
194     "Get the value of a key",
195     1,
196     "1.0.0" },
197     { "GETBIT",
198     "key offset",
199     "Returns the bit value at offset in the string value stored at key",
200     1,
201     "2.2.0" },
202     { "GETRANGE",
203     "key start end",
204     "Get a substring of the string stored at a key",
205     1,
206     "2.4.0" },
207     { "GETSET",
208     "key value",
209     "Set the string value of a key and return its old value",
210     1,
211     "1.0.0" },
212     { "HDEL",
213     "key field [field ...]",
214     "Delete one or more hash fields",
215     5,
216     "2.0.0" },
217     { "HEXISTS",
218     "key field",
219     "Determine if a hash field exists",
220     5,
221     "2.0.0" },
222     { "HGET",
223     "key field",
224     "Get the value of a hash field",
225     5,
226     "2.0.0" },
227     { "HGETALL",
228     "key",
229     "Get all the fields and values in a hash",
230     5,
231     "2.0.0" },
232     { "HINCRBY",
233     "key field increment",
234     "Increment the integer value of a hash field by the given number",
235     5,
236     "2.0.0" },
237     { "HINCRBYFLOAT",
238     "key field increment",
239     "Increment the float value of a hash field by the given amount",
240     5,
241     "2.6.0" },
242     { "HKEYS",
243     "key",
244     "Get all the fields in a hash",
245     5,
246     "2.0.0" },
247     { "HLEN",
248     "key",
249     "Get the number of fields in a hash",
250     5,
251     "2.0.0" },
252     { "HMGET",
253     "key field [field ...]",
254     "Get the values of all the given hash fields",
255     5,
256     "2.0.0" },
257     { "HMSET",
258     "key field value [field value ...]",
259     "Set multiple hash fields to multiple values",
260     5,
261     "2.0.0" },
262     { "HSET",
263     "key field value",
264     "Set the string value of a hash field",
265     5,
266     "2.0.0" },
267     { "HSETNX",
268     "key field value",
269     "Set the value of a hash field, only if the field does not exist",
270     5,
271     "2.0.0" },
272     { "HVALS",
273     "key",
274     "Get all the values in a hash",
275     5,
276     "2.0.0" },
277     { "INCR",
278     "key",
279     "Increment the integer value of a key by one",
280     1,
281     "1.0.0" },
282     { "INCRBY",
283     "key increment",
284     "Increment the integer value of a key by the given amount",
285     1,
286     "1.0.0" },
287     { "INCRBYFLOAT",
288     "key increment",
289     "Increment the float value of a key by the given amount",
290     1,
291     "2.6.0" },
292     { "INFO",
293     "[section]",
294     "Get information and statistics about the server",
295     9,
296     "1.0.0" },
297     { "KEYS",
298     "pattern",
299     "Find all keys matching the given pattern",
300     0,
301     "1.0.0" },
302     { "LASTSAVE",
303     "-",
304     "Get the UNIX time stamp of the last successful save to disk",
305     9,
306     "1.0.0" },
307     { "LINDEX",
308     "key index",
309     "Get an element from a list by its index",
310     2,
311     "1.0.0" },
312     { "LINSERT",
313     "key BEFORE|AFTER pivot value",
314     "Insert an element before or after another element in a list",
315     2,
316     "2.2.0" },
317     { "LLEN",
318     "key",
319     "Get the length of a list",
320     2,
321     "1.0.0" },
322     { "LPOP",
323     "key",
324     "Remove and get the first element in a list",
325     2,
326     "1.0.0" },
327     { "LPUSH",
328     "key value [value ...]",
329     "Prepend one or multiple values to a list",
330     2,
331     "1.0.0" },
332     { "LPUSHX",
333     "key value",
334     "Prepend a value to a list, only if the list exists",
335     2,
336     "2.2.0" },
337     { "LRANGE",
338     "key start stop",
339     "Get a range of elements from a list",
340     2,
341     "1.0.0" },
342     { "LREM",
343     "key count value",
344     "Remove elements from a list",
345     2,
346     "1.0.0" },
347     { "LSET",
348     "key index value",
349     "Set the value of an element in a list by its index",
350     2,
351     "1.0.0" },
352     { "LTRIM",
353     "key start stop",
354     "Trim a list to the specified range",
355     2,
356     "1.0.0" },
357     { "MGET",
358     "key [key ...]",
359     "Get the values of all the given keys",
360     1,
361     "1.0.0" },
362     { "MIGRATE",
363     "host port key destination-db timeout",
364     "Atomically transfer a key from a Redis instance to another one.",
365     0,
366     "2.6.0" },
367     { "MONITOR",
368     "-",
369     "Listen for all requests received by the server in real time",
370     9,
371     "1.0.0" },
372     { "MOVE",
373     "key db",
374     "Move a key to another database",
375     0,
376     "1.0.0" },
377     { "MSET",
378     "key value [key value ...]",
379     "Set multiple keys to multiple values",
380     1,
381     "1.0.1" },
382     { "MSETNX",
383     "key value [key value ...]",
384     "Set multiple keys to multiple values, only if none of the keys exist",
385     1,
386     "1.0.1" },
387     { "MULTI",
388     "-",
389     "Mark the start of a transaction block",
390     7,
391     "1.2.0" },
392     { "OBJECT",
393     "subcommand [arguments [arguments ...]]",
394     "Inspect the internals of Redis objects",
395     0,
396     "2.2.3" },
397     { "PERSIST",
398     "key",
399     "Remove the expiration from a key",
400     0,
401     "2.2.0" },
402     { "PEXPIRE",
403     "key milliseconds",
404     "Set a key's time to live in milliseconds",
405     0,
406     "2.6.0" },
407     { "PEXPIREAT",
408     "key milliseconds-timestamp",
409     "Set the expiration for a key as a UNIX timestamp specified in milliseconds",
410     0,
411     "2.6.0" },
412     { "PING",
413     "-",
414     "Ping the server",
415     8,
416     "1.0.0" },
417     { "PSETEX",
418     "key milliseconds value",
419     "Set the value and expiration in milliseconds of a key",
420     1,
421     "2.6.0" },
422     { "PSUBSCRIBE",
423     "pattern [pattern ...]",
424     "Listen for messages published to channels matching the given patterns",
425     6,
426     "2.0.0" },
427     { "PTTL",
428     "key",
429     "Get the time to live for a key in milliseconds",
430     0,
431     "2.6.0" },
432     { "PUBLISH",
433     "channel message",
434     "Post a message to a channel",
435     6,
436     "2.0.0" },
437     { "PUNSUBSCRIBE",
438     "[pattern [pattern ...]]",
439     "Stop listening for messages posted to channels matching the given patterns",
440     6,
441     "2.0.0" },
442     { "QUIT",
443     "-",
444     "Close the connection",
445     8,
446     "1.0.0" },
447     { "RANDOMKEY",
448     "-",
449     "Return a random key from the keyspace",
450     0,
451     "1.0.0" },
452     { "RENAME",
453     "key newkey",
454     "Rename a key",
455     0,
456     "1.0.0" },
457     { "RENAMENX",
458     "key newkey",
459     "Rename a key, only if the new key does not exist",
460     0,
461     "1.0.0" },
462     { "RESTORE",
463     "key ttl serialized-value",
464     "Create a key using the provided serialized value, previously obtained using DUMP.",
465     0,
466     "2.6.0" },
467     { "RPOP",
468     "key",
469     "Remove and get the last element in a list",
470     2,
471     "1.0.0" },
472     { "RPOPLPUSH",
473     "source destination",
474     "Remove the last element in a list, append it to another list and return it",
475     2,
476     "1.2.0" },
477     { "RPUSH",
478     "key value [value ...]",
479     "Append one or multiple values to a list",
480     2,
481     "1.0.0" },
482     { "RPUSHX",
483     "key value",
484     "Append a value to a list, only if the list exists",
485     2,
486     "2.2.0" },
487     { "SADD",
488     "key member [member ...]",
489     "Add one or more members to a set",
490     3,
491     "1.0.0" },
492     { "SAVE",
493     "-",
494     "Synchronously save the dataset to disk",
495     9,
496     "1.0.0" },
497     { "SCARD",
498     "key",
499     "Get the number of members in a set",
500     3,
501     "1.0.0" },
502     { "SCRIPT EXISTS",
503     "script [script ...]",
504     "Check existence of scripts in the script cache.",
505     10,
506     "2.6.0" },
507     { "SCRIPT FLUSH",
508     "-",
509     "Remove all the scripts from the script cache.",
510     10,
511     "2.6.0" },
512     { "SCRIPT KILL",
513     "-",
514     "Kill the script currently in execution.",
515     10,
516     "2.6.0" },
517     { "SCRIPT LOAD",
518     "script",
519     "Load the specified Lua script into the script cache.",
520     10,
521     "2.6.0" },
522     { "SDIFF",
523     "key [key ...]",
524     "Subtract multiple sets",
525     3,
526     "1.0.0" },
527     { "SDIFFSTORE",
528     "destination key [key ...]",
529     "Subtract multiple sets and store the resulting set in a key",
530     3,
531     "1.0.0" },
532     { "SELECT",
533     "index",
534     "Change the selected database for the current connection",
535     8,
536     "1.0.0" },
537     { "SET",
538     "key value [EX seconds] [PX milliseconds] [NX|XX]",
539     "Set the string value of a key",
540     1,
541     "1.0.0" },
542     { "SETBIT",
543     "key offset value",
544     "Sets or clears the bit at offset in the string value stored at key",
545     1,
546     "2.2.0" },
547     { "SETEX",
548     "key seconds value",
549     "Set the value and expiration of a key",
550     1,
551     "2.0.0" },
552     { "SETNX",
553     "key value",
554     "Set the value of a key, only if the key does not exist",
555     1,
556     "1.0.0" },
557     { "SETRANGE",
558     "key offset value",
559     "Overwrite part of a string at key starting at the specified offset",
560     1,
561     "2.2.0" },
562     { "SHUTDOWN",
563     "[NOSAVE] [SAVE]",
564     "Synchronously save the dataset to disk and then shut down the server",
565     9,
566     "1.0.0" },
567     { "SINTER",
568     "key [key ...]",
569     "Intersect multiple sets",
570     3,
571     "1.0.0" },
572     { "SINTERSTORE",
573     "destination key [key ...]",
574     "Intersect multiple sets and store the resulting set in a key",
575     3,
576     "1.0.0" },
577     { "SISMEMBER",
578     "key member",
579     "Determine if a given value is a member of a set",
580     3,
581     "1.0.0" },
582     { "SLAVEOF",
583     "host port",
584     "Make the server a slave of another instance, or promote it as master",
585     9,
586     "1.0.0" },
587     { "SLOWLOG",
588     "subcommand [argument]",
589     "Manages the Redis slow queries log",
590     9,
591     "2.2.12" },
592     { "SMEMBERS",
593     "key",
594     "Get all the members in a set",
595     3,
596     "1.0.0" },
597     { "SMOVE",
598     "source destination member",
599     "Move a member from one set to another",
600     3,
601     "1.0.0" },
602     { "SORT",
603     "key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC|DESC] [ALPHA] [STORE destination]",
604     "Sort the elements in a list, set or sorted set",
605     0,
606     "1.0.0" },
607     { "SPOP",
608     "key",
609     "Remove and return a random member from a set",
610     3,
611     "1.0.0" },
612     { "SRANDMEMBER",
613     "key [count]",
614     "Get one or multiple random members from a set",
615     3,
616     "1.0.0" },
617     { "SREM",
618     "key member [member ...]",
619     "Remove one or more members from a set",
620     3,
621     "1.0.0" },
622     { "STRLEN",
623     "key",
624     "Get the length of the value stored in a key",
625     1,
626     "2.2.0" },
627     { "SUBSCRIBE",
628     "channel [channel ...]",
629     "Listen for messages published to the given channels",
630     6,
631     "2.0.0" },
632     { "SUNION",
633     "key [key ...]",
634     "Add multiple sets",
635     3,
636     "1.0.0" },
637     { "SUNIONSTORE",
638     "destination key [key ...]",
639     "Add multiple sets and store the resulting set in a key",
640     3,
641     "1.0.0" },
642     { "SYNC",
643     "-",
644     "Internal command used for replication",
645     9,
646     "1.0.0" },
647     { "TIME",
648     "-",
649     "Return the current server time",
650     9,
651     "2.6.0" },
652     { "TTL",
653     "key",
654     "Get the time to live for a key",
655     0,
656     "1.0.0" },
657     { "TYPE",
658     "key",
659     "Determine the type stored at key",
660     0,
661     "1.0.0" },
662     { "UNSUBSCRIBE",
663     "[channel [channel ...]]",
664     "Stop listening for messages posted to the given channels",
665     6,
666     "2.0.0" },
667     { "UNWATCH",
668     "-",
669     "Forget about all watched keys",
670     7,
671     "2.2.0" },
672     { "WATCH",
673     "key [key ...]",
674     "Watch the given keys to determine execution of the MULTI/EXEC block",
675     7,
676     "2.2.0" },
677     { "ZADD",
678     "key score member [score member ...]",
679     "Add one or more members to a sorted set, or update its score if it already exists",
680     4,
681     "1.2.0" },
682     { "ZCARD",
683     "key",
684     "Get the number of members in a sorted set",
685     4,
686     "1.2.0" },
687     { "ZCOUNT",
688     "key min max",
689     "Count the members in a sorted set with scores within the given values",
690     4,
691     "2.0.0" },
692     { "ZINCRBY",
693     "key increment member",
694     "Increment the score of a member in a sorted set",
695     4,
696     "1.2.0" },
697     { "ZINTERSTORE",
698     "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]",
699     "Intersect multiple sorted sets and store the resulting sorted set in a new key",
700     4,
701     "2.0.0" },
702     { "ZRANGE",
703     "key start stop [WITHSCORES]",
704     "Return a range of members in a sorted set, by index",
705     4,
706     "1.2.0" },
707     { "ZRANGEBYSCORE",
708     "key min max [WITHSCORES] [LIMIT offset count]",
709     "Return a range of members in a sorted set, by score",
710     4,
711     "1.0.5" },
712     { "ZRANK",
713     "key member",
714     "Determine the index of a member in a sorted set",
715     4,
716     "2.0.0" },
717     { "ZREM",
718     "key member [member ...]",
719     "Remove one or more members from a sorted set",
720     4,
721     "1.2.0" },
722     { "ZREMRANGEBYRANK",
723     "key start stop",
724     "Remove all members in a sorted set within the given indexes",
725     4,
726     "2.0.0" },
727     { "ZREMRANGEBYSCORE",
728     "key min max",
729     "Remove all members in a sorted set within the given scores",
730     4,
731     "1.2.0" },
732     { "ZREVRANGE",
733     "key start stop [WITHSCORES]",
734     "Return a range of members in a sorted set, by index, with scores ordered from high to low",
735     4,
736     "1.2.0" },
737     { "ZREVRANGEBYSCORE",
738     "key max min [WITHSCORES] [LIMIT offset count]",
739     "Return a range of members in a sorted set, by score, with scores ordered from high to low",
740     4,
741     "2.2.0" },
742     { "ZREVRANK",
743     "key member",
744     "Determine the index of a member in a sorted set, with scores ordered from high to low",
745     4,
746     "2.0.0" },
747     { "ZSCORE",
748     "key member",
749     "Get the score associated with the given member in a sorted set",
750     4,
751     "1.2.0" },
752     { "ZUNIONSTORE",
753     "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]",
754     "Add multiple sorted sets and store the resulting sorted set in a new key",
755     4,
756     "2.0.0" }
757 };
758 
759 #endif
760