help.h 12.7 KB
Newer Older
1
/* Automatically generated by utils/generate-command-help.rb, do not edit. */
2

3 4
#ifndef __REDIS_HELP_H
#define __REDIS_HELP_H
5

6 7 8 9 10 11 12 13 14 15 16
static char *commandGroups[] = {
    "generic",
    "string",
    "list",
    "set",
    "sorted_set",
    "hash",
    "pubsub",
    "transactions",
    "connection",
    "server"
17 18
};

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

608
#endif