Back to home page

Redis cross reference

 
 

    


0001 /* Automatically generated by utils/generate-command-help.rb, do not edit. */
0002 
0003 #ifndef __REDIS_HELP_H
0004 #define __REDIS_HELP_H
0005 
0006 static char *commandGroups[] = {
0007     "generic",
0008     "string",
0009     "list",
0010     "set",
0011     "sorted_set",
0012     "hash",
0013     "pubsub",
0014     "transactions",
0015     "connection",
0016     "server",
0017     "scripting"
0018 };
0019 
0020 struct commandHelp {
0021   char *name;
0022   char *params;
0023   char *summary;
0024   int group;
0025   char *since;
0026 } commandHelp[] = {
0027     { "APPEND",
0028     "key value",
0029     "Append a value to a key",
0030     1,
0031     "2.0.0" },
0032     { "AUTH",
0033     "password",
0034     "Authenticate to the server",
0035     8,
0036     "1.0.0" },
0037     { "BGREWRITEAOF",
0038     "-",
0039     "Asynchronously rewrite the append-only file",
0040     9,
0041     "1.0.0" },
0042     { "BGSAVE",
0043     "-",
0044     "Asynchronously save the dataset to disk",
0045     9,
0046     "1.0.0" },
0047     { "BITCOUNT",
0048     "key [start] [end]",
0049     "Count set bits in a string",
0050     1,
0051     "2.6.0" },
0052     { "BITOP",
0053     "operation destkey key [key ...]",
0054     "Perform bitwise operations between strings",
0055     1,
0056     "2.6.0" },
0057     { "BLPOP",
0058     "key [key ...] timeout",
0059     "Remove and get the first element in a list, or block until one is available",
0060     2,
0061     "2.0.0" },
0062     { "BRPOP",
0063     "key [key ...] timeout",
0064     "Remove and get the last element in a list, or block until one is available",
0065     2,
0066     "2.0.0" },
0067     { "BRPOPLPUSH",
0068     "source destination timeout",
0069     "Pop a value from a list, push it to another list and return it; or block until one is available",
0070     2,
0071     "2.2.0" },
0072     { "CLIENT KILL",
0073     "ip:port",
0074     "Kill the connection of a client",
0075     9,
0076     "2.4.0" },
0077     { "CLIENT LIST",
0078     "-",
0079     "Get the list of client connections",
0080     9,
0081     "2.4.0" },
0082     { "CONFIG GET",
0083     "parameter",
0084     "Get the value of a configuration parameter",
0085     9,
0086     "2.0.0" },
0087     { "CONFIG RESETSTAT",
0088     "-",
0089     "Reset the stats returned by INFO",
0090     9,
0091     "2.0.0" },
0092     { "CONFIG SET",
0093     "parameter value",
0094     "Set a configuration parameter to the given value",
0095     9,
0096     "2.0.0" },
0097     { "DBSIZE",
0098     "-",
0099     "Return the number of keys in the selected database",
0100     9,
0101     "1.0.0" },
0102     { "DEBUG OBJECT",
0103     "key",
0104     "Get debugging information about a key",
0105     9,
0106     "1.0.0" },
0107     { "DEBUG SEGFAULT",
0108     "-",
0109     "Make the server crash",
0110     9,
0111     "1.0.0" },
0112     { "DECR",
0113     "key",
0114     "Decrement the integer value of a key by one",
0115     1,
0116     "1.0.0" },
0117     { "DECRBY",
0118     "key decrement",
0119     "Decrement the integer value of a key by the given number",
0120     1,
0121     "1.0.0" },
0122     { "DEL",
0123     "key [key ...]",
0124     "Delete a key",
0125     0,
0126     "1.0.0" },
0127     { "DISCARD",
0128     "-",
0129     "Discard all commands issued after MULTI",
0130     7,
0131     "2.0.0" },
0132     { "DUMP",
0133     "key",
0134     "Return a serialized version of the value stored at the specified key.",
0135     0,
0136     "2.6.0" },
0137     { "ECHO",
0138     "message",
0139     "Echo the given string",
0140     8,
0141     "1.0.0" },
0142     { "EVAL",
0143     "script numkeys key [key ...] arg [arg ...]",
0144     "Execute a Lua script server side",
0145     10,
0146     "2.6.0" },
0147     { "EVALSHA",
0148     "sha1 numkeys key [key ...] arg [arg ...]",
0149     "Execute a Lua script server side",
0150     10,
0151     "2.6.0" },
0152     { "EXEC",
0153     "-",
0154     "Execute all commands issued after MULTI",
0155     7,
0156     "1.2.0" },
0157     { "EXISTS",
0158     "key",
0159     "Determine if a key exists",
0160     0,
0161     "1.0.0" },
0162     { "EXPIRE",
0163     "key seconds",
0164     "Set a key's time to live in seconds",
0165     0,
0166     "1.0.0" },
0167     { "EXPIREAT",
0168     "key timestamp",
0169     "Set the expiration for a key as a UNIX timestamp",
0170     0,
0171     "1.2.0" },
0172     { "FLUSHALL",
0173     "-",
0174     "Remove all keys from all databases",
0175     9,
0176     "1.0.0" },
0177     { "FLUSHDB",
0178     "-",
0179     "Remove all keys from the current database",
0180     9,
0181     "1.0.0" },
0182     { "GET",
0183     "key",
0184     "Get the value of a key",
0185     1,
0186     "1.0.0" },
0187     { "GETBIT",
0188     "key offset",
0189     "Returns the bit value at offset in the string value stored at key",
0190     1,
0191     "2.2.0" },
0192     { "GETRANGE",
0193     "key start end",
0194     "Get a substring of the string stored at a key",
0195     1,
0196     "2.4.0" },
0197     { "GETSET",
0198     "key value",
0199     "Set the string value of a key and return its old value",
0200     1,
0201     "1.0.0" },
0202     { "HDEL",
0203     "key field [field ...]",
0204     "Delete one or more hash fields",
0205     5,
0206     "2.0.0" },
0207     { "HEXISTS",
0208     "key field",
0209     "Determine if a hash field exists",
0210     5,
0211     "2.0.0" },
0212     { "HGET",
0213     "key field",
0214     "Get the value of a hash field",
0215     5,
0216     "2.0.0" },
0217     { "HGETALL",
0218     "key",
0219     "Get all the fields and values in a hash",
0220     5,
0221     "2.0.0" },
0222     { "HINCRBY",
0223     "key field increment",
0224     "Increment the integer value of a hash field by the given number",
0225     5,
0226     "2.0.0" },
0227     { "HINCRBYFLOAT",
0228     "key field increment",
0229     "Increment the float value of a hash field by the given amount",
0230     5,
0231     "2.6.0" },
0232     { "HKEYS",
0233     "key",
0234     "Get all the fields in a hash",
0235     5,
0236     "2.0.0" },
0237     { "HLEN",
0238     "key",
0239     "Get the number of fields in a hash",
0240     5,
0241     "2.0.0" },
0242     { "HMGET",
0243     "key field [field ...]",
0244     "Get the values of all the given hash fields",
0245     5,
0246     "2.0.0" },
0247     { "HMSET",
0248     "key field value [field value ...]",
0249     "Set multiple hash fields to multiple values",
0250     5,
0251     "2.0.0" },
0252     { "HSET",
0253     "key field value",
0254     "Set the string value of a hash field",
0255     5,
0256     "2.0.0" },
0257     { "HSETNX",
0258     "key field value",
0259     "Set the value of a hash field, only if the field does not exist",
0260     5,
0261     "2.0.0" },
0262     { "HVALS",
0263     "key",
0264     "Get all the values in a hash",
0265     5,
0266     "2.0.0" },
0267     { "INCR",
0268     "key",
0269     "Increment the integer value of a key by one",
0270     1,
0271     "1.0.0" },
0272     { "INCRBY",
0273     "key increment",
0274     "Increment the integer value of a key by the given amount",
0275     1,
0276     "1.0.0" },
0277     { "INCRBYFLOAT",
0278     "key increment",
0279     "Increment the float value of a key by the given amount",
0280     1,
0281     "2.6.0" },
0282     { "INFO",
0283     "-",
0284     "Get information and statistics about the server",
0285     9,
0286     "1.0.0" },
0287     { "KEYS",
0288     "pattern",
0289     "Find all keys matching the given pattern",
0290     0,
0291     "1.0.0" },
0292     { "LASTSAVE",
0293     "-",
0294     "Get the UNIX time stamp of the last successful save to disk",
0295     9,
0296     "1.0.0" },
0297     { "LINDEX",
0298     "key index",
0299     "Get an element from a list by its index",
0300     2,
0301     "1.0.0" },
0302     { "LINSERT",
0303     "key BEFORE|AFTER pivot value",
0304     "Insert an element before or after another element in a list",
0305     2,
0306     "2.2.0" },
0307     { "LLEN",
0308     "key",
0309     "Get the length of a list",
0310     2,
0311     "1.0.0" },
0312     { "LPOP",
0313     "key",
0314     "Remove and get the first element in a list",
0315     2,
0316     "1.0.0" },
0317     { "LPUSH",
0318     "key value [value ...]",
0319     "Prepend one or multiple values to a list",
0320     2,
0321     "1.0.0" },
0322     { "LPUSHX",
0323     "key value",
0324     "Prepend a value to a list, only if the list exists",
0325     2,
0326     "2.2.0" },
0327     { "LRANGE",
0328     "key start stop",
0329     "Get a range of elements from a list",
0330     2,
0331     "1.0.0" },
0332     { "LREM",
0333     "key count value",
0334     "Remove elements from a list",
0335     2,
0336     "1.0.0" },
0337     { "LSET",
0338     "key index value",
0339     "Set the value of an element in a list by its index",
0340     2,
0341     "1.0.0" },
0342     { "LTRIM",
0343     "key start stop",
0344     "Trim a list to the specified range",
0345     2,
0346     "1.0.0" },
0347     { "MGET",
0348     "key [key ...]",
0349     "Get the values of all the given keys",
0350     1,
0351     "1.0.0" },
0352     { "MIGRATE",
0353     "host port key destination-db timeout",
0354     "Atomically transfer a key from a Redis instance to another one.",
0355     0,
0356     "2.6.0" },
0357     { "MONITOR",
0358     "-",
0359     "Listen for all requests received by the server in real time",
0360     9,
0361     "1.0.0" },
0362     { "MOVE",
0363     "key db",
0364     "Move a key to another database",
0365     0,
0366     "1.0.0" },
0367     { "MSET",
0368     "key value [key value ...]",
0369     "Set multiple keys to multiple values",
0370     1,
0371     "1.0.1" },
0372     { "MSETNX",
0373     "key value [key value ...]",
0374     "Set multiple keys to multiple values, only if none of the keys exist",
0375     1,
0376     "1.0.1" },
0377     { "MULTI",
0378     "-",
0379     "Mark the start of a transaction block",
0380     7,
0381     "1.2.0" },
0382     { "OBJECT",
0383     "subcommand [arguments [arguments ...]]",
0384     "Inspect the internals of Redis objects",
0385     0,
0386     "2.2.3" },
0387     { "PERSIST",
0388     "key",
0389     "Remove the expiration from a key",
0390     0,
0391     "2.2.0" },
0392     { "PEXPIRE",
0393     "key milliseconds",
0394     "Set a key's time to live in milliseconds",
0395     0,
0396     "2.6.0" },
0397     { "PEXPIREAT",
0398     "key milliseconds-timestamp",
0399     "Set the expiration for a key as a UNIX timestamp specified in milliseconds",
0400     0,
0401     "2.6.0" },
0402     { "PING",
0403     "-",
0404     "Ping the server",
0405     8,
0406     "1.0.0" },
0407     { "PSETEX",
0408     "key milliseconds value",
0409     "Set the value and expiration in milliseconds of a key",
0410     1,
0411     "2.6.0" },
0412     { "PSUBSCRIBE",
0413     "pattern [pattern ...]",
0414     "Listen for messages published to channels matching the given patterns",
0415     6,
0416     "2.0.0" },
0417     { "PTTL",
0418     "key",
0419     "Get the time to live for a key in milliseconds",
0420     0,
0421     "2.6.0" },
0422     { "PUBLISH",
0423     "channel message",
0424     "Post a message to a channel",
0425     6,
0426     "2.0.0" },
0427     { "PUNSUBSCRIBE",
0428     "[pattern [pattern ...]]",
0429     "Stop listening for messages posted to channels matching the given patterns",
0430     6,
0431     "2.0.0" },
0432     { "QUIT",
0433     "-",
0434     "Close the connection",
0435     8,
0436     "1.0.0" },
0437     { "RANDOMKEY",
0438     "-",
0439     "Return a random key from the keyspace",
0440     0,
0441     "1.0.0" },
0442     { "RENAME",
0443     "key newkey",
0444     "Rename a key",
0445     0,
0446     "1.0.0" },
0447     { "RENAMENX",
0448     "key newkey",
0449     "Rename a key, only if the new key does not exist",
0450     0,
0451     "1.0.0" },
0452     { "RESTORE",
0453     "key ttl serialized-value",
0454     "Create a key using the provided serialized value, previously obtained using DUMP.",
0455     0,
0456     "2.6.0" },
0457     { "RPOP",
0458     "key",
0459     "Remove and get the last element in a list",
0460     2,
0461     "1.0.0" },
0462     { "RPOPLPUSH",
0463     "source destination",
0464     "Remove the last element in a list, append it to another list and return it",
0465     2,
0466     "1.2.0" },
0467     { "RPUSH",
0468     "key value [value ...]",
0469     "Append one or multiple values to a list",
0470     2,
0471     "1.0.0" },
0472     { "RPUSHX",
0473     "key value",
0474     "Append a value to a list, only if the list exists",
0475     2,
0476     "2.2.0" },
0477     { "SADD",
0478     "key member [member ...]",
0479     "Add one or more members to a set",
0480     3,
0481     "1.0.0" },
0482     { "SAVE",
0483     "-",
0484     "Synchronously save the dataset to disk",
0485     9,
0486     "1.0.0" },
0487     { "SCARD",
0488     "key",
0489     "Get the number of members in a set",
0490     3,
0491     "1.0.0" },
0492     { "SCRIPT EXISTS",
0493     "script [script ...]",
0494     "Check existence of scripts in the script cache.",
0495     10,
0496     "2.6.0" },
0497     { "SCRIPT FLUSH",
0498     "-",
0499     "Remove all the scripts from the script cache.",
0500     10,
0501     "2.6.0" },
0502     { "SCRIPT KILL",
0503     "-",
0504     "Kill the script currently in execution.",
0505     10,
0506     "2.6.0" },
0507     { "SCRIPT LOAD",
0508     "script",
0509     "Load the specified Lua script into the script cache.",
0510     10,
0511     "2.6.0" },
0512     { "SDIFF",
0513     "key [key ...]",
0514     "Subtract multiple sets",
0515     3,
0516     "1.0.0" },
0517     { "SDIFFSTORE",
0518     "destination key [key ...]",
0519     "Subtract multiple sets and store the resulting set in a key",
0520     3,
0521     "1.0.0" },
0522     { "SELECT",
0523     "index",
0524     "Change the selected database for the current connection",
0525     8,
0526     "1.0.0" },
0527     { "SET",
0528     "key value",
0529     "Set the string value of a key",
0530     1,
0531     "1.0.0" },
0532     { "SETBIT",
0533     "key offset value",
0534     "Sets or clears the bit at offset in the string value stored at key",
0535     1,
0536     "2.2.0" },
0537     { "SETEX",
0538     "key seconds value",
0539     "Set the value and expiration of a key",
0540     1,
0541     "2.0.0" },
0542     { "SETNX",
0543     "key value",
0544     "Set the value of a key, only if the key does not exist",
0545     1,
0546     "1.0.0" },
0547     { "SETRANGE",
0548     "key offset value",
0549     "Overwrite part of a string at key starting at the specified offset",
0550     1,
0551     "2.2.0" },
0552     { "SHUTDOWN",
0553     "[NOSAVE] [SAVE]",
0554     "Synchronously save the dataset to disk and then shut down the server",
0555     9,
0556     "1.0.0" },
0557     { "SINTER",
0558     "key [key ...]",
0559     "Intersect multiple sets",
0560     3,
0561     "1.0.0" },
0562     { "SINTERSTORE",
0563     "destination key [key ...]",
0564     "Intersect multiple sets and store the resulting set in a key",
0565     3,
0566     "1.0.0" },
0567     { "SISMEMBER",
0568     "key member",
0569     "Determine if a given value is a member of a set",
0570     3,
0571     "1.0.0" },
0572     { "SLAVEOF",
0573     "host port",
0574     "Make the server a slave of another instance, or promote it as master",
0575     9,
0576     "1.0.0" },
0577     { "SLOWLOG",
0578     "subcommand [argument]",
0579     "Manages the Redis slow queries log",
0580     9,
0581     "2.2.12" },
0582     { "SMEMBERS",
0583     "key",
0584     "Get all the members in a set",
0585     3,
0586     "1.0.0" },
0587     { "SMOVE",
0588     "source destination member",
0589     "Move a member from one set to another",
0590     3,
0591     "1.0.0" },
0592     { "SORT",
0593     "key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC|DESC] [ALPHA] [STORE destination]",
0594     "Sort the elements in a list, set or sorted set",
0595     0,
0596     "1.0.0" },
0597     { "SPOP",
0598     "key",
0599     "Remove and return a random member from a set",
0600     3,
0601     "1.0.0" },
0602     { "SRANDMEMBER",
0603     "key [count]",
0604     "Get one or multiple random members from a set",
0605     3,
0606     "1.0.0" },
0607     { "SREM",
0608     "key member [member ...]",
0609     "Remove one or more members from a set",
0610     3,
0611     "1.0.0" },
0612     { "STRLEN",
0613     "key",
0614     "Get the length of the value stored in a key",
0615     1,
0616     "2.2.0" },
0617     { "SUBSCRIBE",
0618     "channel [channel ...]",
0619     "Listen for messages published to the given channels",
0620     6,
0621     "2.0.0" },
0622     { "SUNION",
0623     "key [key ...]",
0624     "Add multiple sets",
0625     3,
0626     "1.0.0" },
0627     { "SUNIONSTORE",
0628     "destination key [key ...]",
0629     "Add multiple sets and store the resulting set in a key",
0630     3,
0631     "1.0.0" },
0632     { "SYNC",
0633     "-",
0634     "Internal command used for replication",
0635     9,
0636     "1.0.0" },
0637     { "TIME",
0638     "-",
0639     "Return the current server time",
0640     9,
0641     "2.6.0" },
0642     { "TTL",
0643     "key",
0644     "Get the time to live for a key",
0645     0,
0646     "1.0.0" },
0647     { "TYPE",
0648     "key",
0649     "Determine the type stored at key",
0650     0,
0651     "1.0.0" },
0652     { "UNSUBSCRIBE",
0653     "[channel [channel ...]]",
0654     "Stop listening for messages posted to the given channels",
0655     6,
0656     "2.0.0" },
0657     { "UNWATCH",
0658     "-",
0659     "Forget about all watched keys",
0660     7,
0661     "2.2.0" },
0662     { "WATCH",
0663     "key [key ...]",
0664     "Watch the given keys to determine execution of the MULTI/EXEC block",
0665     7,
0666     "2.2.0" },
0667     { "ZADD",
0668     "key score member [score] [member]",
0669     "Add one or more members to a sorted set, or update its score if it already exists",
0670     4,
0671     "1.2.0" },
0672     { "ZCARD",
0673     "key",
0674     "Get the number of members in a sorted set",
0675     4,
0676     "1.2.0" },
0677     { "ZCOUNT",
0678     "key min max",
0679     "Count the members in a sorted set with scores within the given values",
0680     4,
0681     "2.0.0" },
0682     { "ZINCRBY",
0683     "key increment member",
0684     "Increment the score of a member in a sorted set",
0685     4,
0686     "1.2.0" },
0687     { "ZINTERSTORE",
0688     "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]",
0689     "Intersect multiple sorted sets and store the resulting sorted set in a new key",
0690     4,
0691     "2.0.0" },
0692     { "ZRANGE",
0693     "key start stop [WITHSCORES]",
0694     "Return a range of members in a sorted set, by index",
0695     4,
0696     "1.2.0" },
0697     { "ZRANGEBYSCORE",
0698     "key min max [WITHSCORES] [LIMIT offset count]",
0699     "Return a range of members in a sorted set, by score",
0700     4,
0701     "1.0.5" },
0702     { "ZRANK",
0703     "key member",
0704     "Determine the index of a member in a sorted set",
0705     4,
0706     "2.0.0" },
0707     { "ZREM",
0708     "key member [member ...]",
0709     "Remove one or more members from a sorted set",
0710     4,
0711     "1.2.0" },
0712     { "ZREMRANGEBYRANK",
0713     "key start stop",
0714     "Remove all members in a sorted set within the given indexes",
0715     4,
0716     "2.0.0" },
0717     { "ZREMRANGEBYSCORE",
0718     "key min max",
0719     "Remove all members in a sorted set within the given scores",
0720     4,
0721     "1.2.0" },
0722     { "ZREVRANGE",
0723     "key start stop [WITHSCORES]",
0724     "Return a range of members in a sorted set, by index, with scores ordered from high to low",
0725     4,
0726     "1.2.0" },
0727     { "ZREVRANGEBYSCORE",
0728     "key max min [WITHSCORES] [LIMIT offset count]",
0729     "Return a range of members in a sorted set, by score, with scores ordered from high to low",
0730     4,
0731     "2.2.0" },
0732     { "ZREVRANK",
0733     "key member",
0734     "Determine the index of a member in a sorted set, with scores ordered from high to low",
0735     4,
0736     "2.0.0" },
0737     { "ZSCORE",
0738     "key member",
0739     "Get the score associated with the given member in a sorted set",
0740     4,
0741     "1.2.0" },
0742     { "ZUNIONSTORE",
0743     "destination numkeys key [key ...] [WEIGHTS weight] [AGGREGATE SUM|MIN|MAX]",
0744     "Add multiple sorted sets and store the resulting sorted set in a new key",
0745     4,
0746     "2.0.0" }
0747 };
0748 
0749 #endif