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