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