src/help.h

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