xref: /redis-3.2.3/src/help.h (revision 4942145d) 
1 /* Automatically generated by 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 };
18 
19 struct commandHelp {
20   char *name;
21   char *params;
22   char *summary;
23   int group;
24   char *since;
25 } commandHelp[] = {
26     { "APPEND",
27     "key value",
28     "Append a value to a key",
29     1,
30     "1.3.3" },
31     { "AUTH",
32     "password",
33     "Authenticate to the server",
34     8,
35     "0.08" },
36     { "BGREWRITEAOF",
37     "-",
38     "Asynchronously rewrite the append-only file",
39     9,
40     "1.07" },
41     { "BGSAVE",
42     "-",
43     "Asynchronously save the dataset to disk",
44     9,
45     "0.07" },
46     { "BLPOP",
47     "key [key ...] timeout",
48     "Remove and get the first element in a list, or block until one is available",
49     2,
50     "1.3.1" },
51     { "BRPOP",
52     "key [key ...] timeout",
53     "Remove and get the last element in a list, or block until one is available",
54     2,
55     "1.3.1" },
56     { "BRPOPLPUSH",
57     "source destination timeout",
58     "Pop a value from a list, push it to another list and return it; or block until one is available",
59     2,
60     "2.1.7" },
61     { "CONFIG GET",
62     "parameter",
63     "Get the value of a configuration parameter",
64     9,
65     "2.0" },
66     { "CONFIG RESETSTAT",
67     "-",
68     "Reset the stats returned by INFO",
69     9,
70     "2.0" },
71     { "CONFIG SET",
72     "parameter value",
73     "Set a configuration parameter to the given value",
74     9,
75     "2.0" },
76     { "DBSIZE",
77     "-",
78     "Return the number of keys in the selected database",
79     9,
80     "0.07" },
81     { "DEBUG OBJECT",
82     "key",
83     "Get debugging information about a key",
84     9,
85     "0.101" },
86     { "DEBUG SEGFAULT",
87     "-",
88     "Make the server crash",
89     9,
90     "0.101" },
91     { "DECR",
92     "key",
93     "Decrement the integer value of a key by one",
94     1,
95     "0.07" },
96     { "DECRBY",
97     "key decrement",
98     "Decrement the integer value of a key by the given number",
99     1,
100     "0.07" },
101     { "DEL",
102     "key [key ...]",
103     "Delete a key",
104     0,
105     "0.07" },
106     { "DISCARD",
107     "-",
108     "Discard all commands issued after MULTI",
109     7,
110     "1.3.3" },
111     { "ECHO",
112     "message",
113     "Echo the given string",
114     8,
115     "0.07" },
116     { "EXEC",
117     "-",
118     "Execute all commands issued after MULTI",
119     7,
120     "1.1.95" },
121     { "EXISTS",
122     "key",
123     "Determine if a key exists",
124     9,
125     "0.07" },
126     { "EXPIRE",
127     "key seconds",
128     "Set a key's time to live in seconds",
129     0,
130     "0.09" },
131     { "EXPIREAT",
132     "key timestamp",
133     "Set the expiration for a key as a UNIX timestamp",
134     0,
135     "1.1" },
136     { "FLUSHALL",
137     "-",
138     "Remove all keys from all databases",
139     9,
140     "0.07" },
141     { "FLUSHDB",
142     "-",
143     "Remove all keys from the current database",
144     9,
145     "0.07" },
146     { "GET",
147     "key",
148     "Get the value of a key",
149     1,
150     "0.07" },
151     { "GETBIT",
152     "key offset",
153     "Returns the bit value at offset in the string value stored at key",
154     1,
155     "2.1.8" },
156     { "GETSET",
157     "key value",
158     "Set the string value of a key and return its old value",
159     1,
160     "0.091" },
161     { "HDEL",
162     "key field",
163     "Delete a hash field",
164     5,
165     "1.3.10" },
166     { "HEXISTS",
167     "key field",
168     "Determine if a hash field exists",
169     5,
170     "1.3.10" },
171     { "HGET",
172     "key field",
173     "Get the value of a hash field",
174     5,
175     "1.3.10" },
176     { "HGETALL",
177     "key",
178     "Get all the fields and values in a hash",
179     5,
180     "1.3.10" },
181     { "HINCRBY",
182     "key field increment",
183     "Increment the integer value of a hash field by the given number",
184     5,
185     "1.3.10" },
186     { "HKEYS",
187     "key",
188     "Get all the fields in a hash",
189     5,
190     "1.3.10" },
191     { "HLEN",
192     "key",
193     "Get the number of fields in a hash",
194     5,
195     "1.3.10" },
196     { "HMGET",
197     "key field [field ...]",
198     "Get the values of all the given hash fields",
199     5,
200     "1.3.10" },
201     { "HMSET",
202     "key field value [field value ...]",
203     "Set multiple hash fields to multiple values",
204     5,
205     "1.3.8" },
206     { "HSET",
207     "key field value",
208     "Set the string value of a hash field",
209     5,
210     "1.3.10" },
211     { "HSETNX",
212     "key field value",
213     "Set the value of a hash field, only if the field does not exist",
214     5,
215     "1.3.8" },
216     { "HVALS",
217     "key",
218     "Get all the values in a hash",
219     5,
220     "1.3.10" },
221     { "INCR",
222     "key",
223     "Increment the integer value of a key by one",
224     1,
225     "0.07" },
226     { "INCRBY",
227     "key increment",
228     "Increment the integer value of a key by the given number",
229     1,
230     "0.07" },
231     { "INFO",
232     "-",
233     "Get information and statistics about the server",
234     9,
235     "0.07" },
236     { "KEYS",
237     "pattern",
238     "Find all keys matching the given pattern",
239     0,
240     "0.07" },
241     { "LASTSAVE",
242     "-",
243     "Get the UNIX time stamp of the last successful save to disk",
244     9,
245     "0.07" },
246     { "LINDEX",
247     "key index",
248     "Get an element from a list by its index",
249     2,
250     "0.07" },
251     { "LINSERT",
252     "key BEFORE|AFTER pivot value",
253     "Insert an element before or after another element in a list",
254     2,
255     "2.1.1" },
256     { "LLEN",
257     "key",
258     "Get the length of a list",
259     2,
260     "0.07" },
261     { "LPOP",
262     "key",
263     "Remove and get the first element in a list",
264     2,
265     "0.07" },
266     { "LPUSH",
267     "key value",
268     "Prepend a value to a list",
269     2,
270     "0.07" },
271     { "LPUSHX",
272     "key value",
273     "Prepend a value to a list, only if the list exists",
274     2,
275     "2.1.1" },
276     { "LRANGE",
277     "key start stop",
278     "Get a range of elements from a list",
279     2,
280     "0.07" },
281     { "LREM",
282     "key count value",
283     "Remove elements from a list",
284     2,
285     "0.07" },
286     { "LSET",
287     "key index value",
288     "Set the value of an element in a list by its index",
289     2,
290     "0.07" },
291     { "LTRIM",
292     "key start stop",
293     "Trim a list to the specified range",
294     2,
295     "0.07" },
296     { "MGET",
297     "key [key ...]",
298     "Get the values of all the given keys",
299     1,
300     "0.07" },
301     { "MONITOR",
302     "-",
303     "Listen for all requests received by the server in real time",
304     9,
305     "0.07" },
306     { "MOVE",
307     "key db",
308     "Move a key to another database",
309     0,
310     "0.07" },
311     { "MSET",
312     "key value [key value ...]",
313     "Set multiple keys to multiple values",
314     1,
315     "1.001" },
316     { "MSETNX",
317     "key value [key value ...]",
318     "Set multiple keys to multiple values, only if none of the keys exist",
319     1,
320     "1.001" },
321     { "MULTI",
322     "-",
323     "Mark the start of a transaction block",
324     7,
325     "1.1.95" },
326     { "PERSIST",
327     "key",
328     "Remove the expiration from a key",
329     0,
330     "2.1.2" },
331     { "PING",
332     "-",
333     "Ping the server",
334     8,
335     "0.07" },
336     { "PSUBSCRIBE",
337     "pattern",
338     "Listen for messages published to channels matching the given patterns",
339     6,
340     "1.3.8" },
341     { "PUBLISH",
342     "channel message",
343     "Post a message to a channel",
344     6,
345     "1.3.8" },
346     { "PUNSUBSCRIBE",
347     "[pattern [pattern ...]]",
348     "Stop listening for messages posted to channels matching the given patterns",
349     6,
350     "1.3.8" },
351     { "QUIT",
352     "-",
353     "Close the connection",
354     8,
355     "0.07" },
356     { "RANDOMKEY",
357     "-",
358     "Return a random key from the keyspace",
359     0,
360     "0.07" },
361     { "RENAME",
362     "key newkey",
363     "Rename a key",
364     0,
365     "0.07" },
366     { "RENAMENX",
367     "key newkey",
368     "Rename a key, only if the new key does not exist",
369     0,
370     "0.07" },
371     { "RPOP",
372     "key",
373     "Remove and get the last element in a list",
374     2,
375     "0.07" },
376     { "RPOPLPUSH",
377     "source destination",
378     "Remove the last element in a list, append it to another list and return it",
379     2,
380     "1.1" },
381     { "RPUSH",
382     "key value",
383     "Append a value to a list",
384     2,
385     "0.07" },
386     { "RPUSHX",
387     "key value",
388     "Append a value to a list, only if the list exists",
389     2,
390     "2.1.1" },
391     { "SADD",
392     "key member",
393     "Add a member to a set",
394     3,
395     "0.07" },
396     { "SAVE",
397     "-",
398     "Synchronously save the dataset to disk",
399     9,
400     "0.07" },
401     { "SCARD",
402     "key",
403     "Get the number of members in a set",
404     3,
405     "0.07" },
406     { "SDIFF",
407     "key [key ...]",
408     "Subtract multiple sets",
409     3,
410     "0.100" },
411     { "SDIFFSTORE",
412     "destination key [key ...]",
413     "Subtract multiple sets and store the resulting set in a key",
414     3,
415     "0.100" },
416     { "SELECT",
417     "index",
418     "Change the selected database for the current connection",
419     8,
420     "0.07" },
421     { "SET",
422     "key value",
423     "Set the string value of a key",
424     1,
425     "0.07" },
426     { "SETBIT",
427     "key offset value",
428     "Sets or clears the bit at offset in the string value stored at key",
429     1,
430     "2.1.8" },
431     { "SETEX",
432     "key seconds value",
433     "Set the value and expiration of a key",
434     1,
435     "1.3.10" },
436     { "SETNX",
437     "key value",
438     "Set the value of a key, only if the key does not exist",
439     1,
440     "0.07" },
441     { "SETRANGE",
442     "key offset value",
443     "Overwrite part of a string at key starting at the specified offset",
444     1,
445     "2.1.8" },
446     { "SHUTDOWN",
447     "-",
448     "Synchronously save the dataset to disk and then shut down the server",
449     9,
450     "0.07" },
451     { "SINTER",
452     "key [key ...]",
453     "Intersect multiple sets",
454     3,
455     "0.07" },
456     { "SINTERSTORE",
457     "destination key [key ...]",
458     "Intersect multiple sets and store the resulting set in a key",
459     3,
460     "0.07" },
461     { "SISMEMBER",
462     "key member",
463     "Determine if a given value is a member of a set",
464     3,
465     "0.07" },
466     { "SLAVEOF",
467     "host port",
468     "Make the server a slave of another instance, or promote it as master",
469     9,
470     "0.100" },
471     { "SMEMBERS",
472     "key",
473     "Get all the members in a set",
474     3,
475     "0.07" },
476     { "SMOVE",
477     "source destination member",
478     "Move a member from one set to another",
479     3,
480     "0.091" },
481     { "SORT",
482     "key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC|DESC] [ALPHA] [STORE destination]",
483     "Sort the elements in a list, set or sorted set",
484     0,
485     "0.07" },
486     { "SPOP",
487     "key",
488     "Remove and return a random member from a set",
489     3,
490     "0.101" },
491     { "SRANDMEMBER",
492     "key",
493     "Get a random member from a set",
494     3,
495     "1.001" },
496     { "SREM",
497     "key member",
498     "Remove a member from a set",
499     3,
500     "0.07" },
501     { "STRLEN",
502     "key",
503     "Get the length of the value stored in a key",
504     1,
505     "2.1.2" },
506     { "SUBSCRIBE",
507     "channel",
508     "Listen for messages published to the given channels",
509     6,
510     "1.3.8" },
511     { "SUBSTR",
512     "key start end",
513     "Get a substring of the string stored at a key",
514     1,
515     "1.3.4" },
516     { "SUNION",
517     "key [key ...]",
518     "Add multiple sets",
519     3,
520     "0.091" },
521     { "SUNIONSTORE",
522     "destination key [key ...]",
523     "Add multiple sets and store the resulting set in a key",
524     3,
525     "0.091" },
526     { "SYNC",
527     "-",
528     "Internal command used for replication",
529     9,
530     "0.07" },
531     { "TTL",
532     "key",
533     "Get the time to live for a key",
534     0,
535     "0.100" },
536     { "TYPE",
537     "key",
538     "Determine the type stored at key",
539     0,
540     "0.07" },
541     { "UNSUBSCRIBE",
542     "[channel [channel ...]]",
543     "Stop listening for messages posted to the given channels",
544     6,
545     "1.3.8" },
546     { "UNWATCH",
547     "-",
548     "Forget about all watched keys",
549     7,
550     "2.1.0" },
551     { "WATCH",
552     "key [key ...]",
553     "Watch the given keys to determine execution of the MULTI/EXEC block",
554     7,
555     "2.1.0" },
556     { "ZADD",
557     "key score member",
558     "Add a member to a sorted set, or update its score if it already exists",
559     4,
560     "1.1" },
561     { "ZCARD",
562     "key",
563     "Get the number of members in a sorted set",
564     4,
565     "1.1" },
566     { "ZCOUNT",
567     "key min max",
568     "Count the members in a sorted set with scores within the given values",
569     4,
570     "1.3.3" },
571     { "ZINCRBY",
572     "key increment member",
573     "Increment the score of a member in a sorted set",
574     4,
575     "1.1" },
576     { "ZINTERSTORE",
577     "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]",
578     "Intersect multiple sorted sets and store the resulting sorted set in a new key",
579     4,
580     "1.3.10" },
581     { "ZRANGE",
582     "key start stop [WITHSCORES]",
583     "Return a range of members in a sorted set, by index",
584     4,
585     "1.1" },
586     { "ZRANGEBYSCORE",
587     "key min max [WITHSCORES] [LIMIT offset count]",
588     "Return a range of members in a sorted set, by score",
589     4,
590     "1.050" },
591     { "ZRANK",
592     "key member",
593     "Determine the index of a member in a sorted set",
594     4,
595     "1.3.4" },
596     { "ZREM",
597     "key member",
598     "Remove a member from a sorted set",
599     4,
600     "1.1" },
601     { "ZREMRANGEBYRANK",
602     "key start stop",
603     "Remove all members in a sorted set within the given indexes",
604     4,
605     "1.3.4" },
606     { "ZREMRANGEBYSCORE",
607     "key min max",
608     "Remove all members in a sorted set within the given scores",
609     4,
610     "1.1" },
611     { "ZREVRANGE",
612     "key start stop [WITHSCORES]",
613     "Return a range of members in a sorted set, by index, with scores ordered from high to low",
614     4,
615     "1.1" },
616     { "ZREVRANGEBYSCORE",
617     "key max min [WITHSCORES] [LIMIT offset count]",
618     "Return a range of members in a sorted set, by score, with scores ordered from high to low",
619     4,
620     "2.1.6" },
621     { "ZREVRANK",
622     "key member",
623     "Determine the index of a member in a sorted set, with scores ordered from high to low",
624     4,
625     "1.3.4" },
626     { "ZSCORE",
627     "key member",
628     "Get the score associated with the given member in a sorted set",
629     4,
630     "1.1" },
631     { "ZUNIONSTORE",
632     "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]",
633     "Add multiple sorted sets and store the resulting sorted set in a new key",
634     4,
635     "1.3.10" }
636 };
637 
638 #endif
639