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