redis-cli command help updated.

This commit is contained in:
antirez 2020-04-30 13:00:37 +02:00
parent 15b040907c
commit 6fcdf75325

View File

@ -28,6 +28,56 @@ struct commandHelp {
int group; int group;
char *since; char *since;
} commandHelp[] = { } commandHelp[] = {
{ "ACL CAT",
"[categoryname]",
"List the ACL categories or the commands inside a category",
9,
"6.0.0" },
{ "ACL DELUSER",
"username [username ...]",
"Remove the specified ACL users and the associated rules",
9,
"6.0.0" },
{ "ACL GENPASS",
"[bits]",
"Generate a pseudorandom secure password to use for ACL users",
9,
"6.0.0" },
{ "ACL LIST",
"-",
"List the current ACL rules in ACL config file format",
9,
"6.0.0" },
{ "ACL LOAD",
"-",
"Reload the ACLs from the configured ACL file",
9,
"6.0.0" },
{ "ACL LOG",
"[count or RESET]",
"List latest events denied because of ACLs in place",
9,
"6.0.0" },
{ "ACL SAVE",
"-",
"Save the current ACL rules in the configured ACL file",
9,
"6.0.0" },
{ "ACL SETUSER",
"rule [rule ...]",
"Modify or create the rules for a specific ACL user",
9,
"6.0.0" },
{ "ACL USERS",
"-",
"List the username of all the configured ACL rules",
9,
"6.0.0" },
{ "ACL WHOAMI",
"-",
"Return the name of the user associated to the current connection",
9,
"6.0.0" },
{ "APPEND", { "APPEND",
"key value", "key value",
"Append a value to a key", "Append a value to a key",
@ -44,7 +94,7 @@ struct commandHelp {
9, 9,
"1.0.0" }, "1.0.0" },
{ "BGSAVE", { "BGSAVE",
"-", "[SCHEDULE]",
"Asynchronously save the dataset to disk", "Asynchronously save the dataset to disk",
9, 9,
"1.0.0" }, "1.0.0" },
@ -80,7 +130,7 @@ struct commandHelp {
"2.0.0" }, "2.0.0" },
{ "BRPOPLPUSH", { "BRPOPLPUSH",
"source destination timeout", "source destination timeout",
"Pop a value from a list, push it to another list and return it; or block until one is available", "Pop an element from a list, push it to another list and return it; or block until one is available",
2, 2,
"2.2.0" }, "2.2.0" },
{ "BZPOPMAX", { "BZPOPMAX",
@ -93,11 +143,21 @@ struct commandHelp {
"Remove and return the member with the lowest score from one or more sorted sets, or block until one is available", "Remove and return the member with the lowest score from one or more sorted sets, or block until one is available",
4, 4,
"5.0.0" }, "5.0.0" },
{ "CLIENT CACHING",
"YES|NO",
"Instruct the server about tracking or not keys in the next request",
9,
"6.0.0" },
{ "CLIENT GETNAME", { "CLIENT GETNAME",
"-", "-",
"Get the current connection name", "Get the current connection name",
9, 9,
"2.6.9" }, "2.6.9" },
{ "CLIENT GETREDIR",
"-",
"Get tracking notifications redirection client ID if any",
9,
"6.0.0" },
{ "CLIENT ID", { "CLIENT ID",
"-", "-",
"Returns the client ID for the current connection", "Returns the client ID for the current connection",
@ -109,7 +169,7 @@ struct commandHelp {
9, 9,
"2.4.0" }, "2.4.0" },
{ "CLIENT LIST", { "CLIENT LIST",
"-", "[TYPE normal|master|replica|pubsub]",
"Get the list of client connections", "Get the list of client connections",
9, 9,
"2.4.0" }, "2.4.0" },
@ -128,6 +188,11 @@ struct commandHelp {
"Set the current connection name", "Set the current connection name",
9, 9,
"2.6.9" }, "2.6.9" },
{ "CLIENT TRACKING",
"ON|OFF [REDIRECT client-id] [PREFIX prefix] [BCAST] [OPTIN] [OPTOUT] [NOLOOP]",
"Enable or disable server assisted client side caching support",
9,
"6.0.0" },
{ "CLIENT UNBLOCK", { "CLIENT UNBLOCK",
"client-id [TIMEOUT|ERROR]", "client-id [TIMEOUT|ERROR]",
"Unblock a client blocked in a blocking command from a different connection", "Unblock a client blocked in a blocking command from a different connection",
@ -138,6 +203,11 @@ struct commandHelp {
"Assign new hash slots to receiving node", "Assign new hash slots to receiving node",
12, 12,
"3.0.0" }, "3.0.0" },
{ "CLUSTER BUMPEPOCH",
"-",
"Advance the cluster config epoch",
12,
"3.0.0" },
{ "CLUSTER COUNT-FAILURE-REPORTS", { "CLUSTER COUNT-FAILURE-REPORTS",
"node-id", "node-id",
"Return the number of failure reports active for a given node", "Return the number of failure reports active for a given node",
@ -158,6 +228,11 @@ struct commandHelp {
"Forces a replica to perform a manual failover of its master.", "Forces a replica to perform a manual failover of its master.",
12, 12,
"3.0.0" }, "3.0.0" },
{ "CLUSTER FLUSHSLOTS",
"-",
"Delete a node's own slots information",
12,
"3.0.0" },
{ "CLUSTER FORGET", { "CLUSTER FORGET",
"node-id", "node-id",
"Remove a node from the nodes table", "Remove a node from the nodes table",
@ -183,6 +258,11 @@ struct commandHelp {
"Force a node cluster to handshake with another node", "Force a node cluster to handshake with another node",
12, 12,
"3.0.0" }, "3.0.0" },
{ "CLUSTER MYID",
"-",
"Return the node id",
12,
"3.0.0" },
{ "CLUSTER NODES", { "CLUSTER NODES",
"-", "-",
"Get Cluster config for the node", "Get Cluster config for the node",
@ -359,7 +439,7 @@ struct commandHelp {
13, 13,
"3.2.0" }, "3.2.0" },
{ "GEODIST", { "GEODIST",
"key member1 member2 [unit]", "key member1 member2 [m|km|ft|mi]",
"Returns the distance between two members of a geospatial index", "Returns the distance between two members of a geospatial index",
13, 13,
"3.2.0" }, "3.2.0" },
@ -459,7 +539,7 @@ struct commandHelp {
5, 5,
"2.8.0" }, "2.8.0" },
{ "HSET", { "HSET",
"key field value", "key field value [field value ...]",
"Set the string value of a hash field", "Set the string value of a hash field",
5, 5,
"2.0.0" }, "2.0.0" },
@ -508,13 +588,43 @@ struct commandHelp {
"Get the UNIX time stamp of the last successful save to disk", "Get the UNIX time stamp of the last successful save to disk",
9, 9,
"1.0.0" }, "1.0.0" },
{ "LATENCY DOCTOR",
"-",
"Return a human readable latency analysis report.",
9,
"2.8.13" },
{ "LATENCY GRAPH",
"event",
"Return a latency graph for the event.",
9,
"2.8.13" },
{ "LATENCY HELP",
"-",
"Show helpful text about the different subcommands.",
9,
"2.8.13" },
{ "LATENCY HISTORY",
"event",
"Return timestamp-latency samples for the event.",
9,
"2.8.13" },
{ "LATENCY LATEST",
"-",
"Return the latest latency samples for all events.",
9,
"2.8.13" },
{ "LATENCY RESET",
"[event]",
"Reset latency data for one or more events.",
9,
"2.8.13" },
{ "LINDEX", { "LINDEX",
"key index", "key index",
"Get an element from a list by its index", "Get an element from a list by its index",
2, 2,
"1.0.0" }, "1.0.0" },
{ "LINSERT", { "LINSERT",
"key BEFORE|AFTER pivot value", "key BEFORE|AFTER pivot element",
"Insert an element before or after another element in a list", "Insert an element before or after another element in a list",
2, 2,
"2.2.0" }, "2.2.0" },
@ -523,19 +633,24 @@ struct commandHelp {
"Get the length of a list", "Get the length of a list",
2, 2,
"1.0.0" }, "1.0.0" },
{ "LOLWUT",
"[VERSION version]",
"Display some computer art and the Redis version",
9,
"5.0.0" },
{ "LPOP", { "LPOP",
"key", "key",
"Remove and get the first element in a list", "Remove and get the first element in a list",
2, 2,
"1.0.0" }, "1.0.0" },
{ "LPUSH", { "LPUSH",
"key value [value ...]", "key element [element ...]",
"Prepend one or multiple values to a list", "Prepend one or multiple elements to a list",
2, 2,
"1.0.0" }, "1.0.0" },
{ "LPUSHX", { "LPUSHX",
"key value", "key element [element ...]",
"Prepend a value to a list, only if the list exists", "Prepend an element to a list, only if the list exists",
2, 2,
"2.2.0" }, "2.2.0" },
{ "LRANGE", { "LRANGE",
@ -544,12 +659,12 @@ struct commandHelp {
2, 2,
"1.0.0" }, "1.0.0" },
{ "LREM", { "LREM",
"key count value", "key count element",
"Remove elements from a list", "Remove elements from a list",
2, 2,
"1.0.0" }, "1.0.0" },
{ "LSET", { "LSET",
"key index value", "key index element",
"Set the value of an element in a list by its index", "Set the value of an element in a list by its index",
2, 2,
"1.0.0" }, "1.0.0" },
@ -594,10 +709,25 @@ struct commandHelp {
1, 1,
"1.0.0" }, "1.0.0" },
{ "MIGRATE", { "MIGRATE",
"host port key|"" destination-db timeout [COPY] [REPLACE] [KEYS key]", "host port key|"" destination-db timeout [COPY] [REPLACE] [AUTH password] [KEYS key]",
"Atomically transfer a key from a Redis instance to another one.", "Atomically transfer a key from a Redis instance to another one.",
0, 0,
"2.6.0" }, "2.6.0" },
{ "MODULE LIST",
"-",
"List all modules loaded by the server",
9,
"4.0.0" },
{ "MODULE LOAD",
"path [arg]",
"Load a module",
9,
"4.0.0" },
{ "MODULE UNLOAD",
"name",
"Unload a module",
9,
"4.0.0" },
{ "MONITOR", { "MONITOR",
"-", "-",
"Listen for all requests received by the server in real time", "Listen for all requests received by the server in real time",
@ -673,6 +803,11 @@ struct commandHelp {
"Listen for messages published to channels matching the given patterns", "Listen for messages published to channels matching the given patterns",
6, 6,
"2.0.0" }, "2.0.0" },
{ "PSYNC",
"replicationid offset",
"Internal command used for replication",
9,
"2.8.0" },
{ "PTTL", { "PTTL",
"key", "key",
"Get the time to live for a key in milliseconds", "Get the time to live for a key in milliseconds",
@ -729,7 +864,7 @@ struct commandHelp {
9, 9,
"5.0.0" }, "5.0.0" },
{ "RESTORE", { "RESTORE",
"key ttl serialized-value [REPLACE]", "key ttl serialized-value [REPLACE] [ABSTTL] [IDLETIME seconds] [FREQ frequency]",
"Create a key using the provided serialized value, previously obtained using DUMP.", "Create a key using the provided serialized value, previously obtained using DUMP.",
0, 0,
"2.6.0" }, "2.6.0" },
@ -749,13 +884,13 @@ struct commandHelp {
2, 2,
"1.2.0" }, "1.2.0" },
{ "RPUSH", { "RPUSH",
"key value [value ...]", "key element [element ...]",
"Append one or multiple values to a list", "Append one or multiple elements to a list",
2, 2,
"1.0.0" }, "1.0.0" },
{ "RPUSHX", { "RPUSHX",
"key value", "key element [element ...]",
"Append a value to a list, only if the list exists", "Append an element to a list, only if the list exists",
2, 2,
"2.2.0" }, "2.2.0" },
{ "SADD", { "SADD",
@ -769,7 +904,7 @@ struct commandHelp {
9, 9,
"1.0.0" }, "1.0.0" },
{ "SCAN", { "SCAN",
"cursor [MATCH pattern] [COUNT count]", "cursor [MATCH pattern] [COUNT count] [TYPE type]",
"Incrementally iterate the keys space", "Incrementally iterate the keys space",
0, 0,
"2.8.0" }, "2.8.0" },
@ -819,7 +954,7 @@ struct commandHelp {
8, 8,
"1.0.0" }, "1.0.0" },
{ "SET", { "SET",
"key value [expiration EX seconds|PX milliseconds] [NX|XX]", "key value [EX seconds|PX milliseconds] [NX|XX] [KEEPTTL]",
"Set the string value of a key", "Set the string value of a key",
1, 1,
"1.0.0" }, "1.0.0" },
@ -908,6 +1043,11 @@ struct commandHelp {
"Incrementally iterate Set elements", "Incrementally iterate Set elements",
3, 3,
"2.8.0" }, "2.8.0" },
{ "STRALGO",
"LCS algo-specific-argument [algo-specific-argument ...]",
"Run algorithms (currently LCS) against strings",
1,
"6.0.0" },
{ "STRLEN", { "STRLEN",
"key", "key",
"Get the length of the value stored in a key", "Get the length of the value stored in a key",
@ -929,7 +1069,7 @@ struct commandHelp {
3, 3,
"1.0.0" }, "1.0.0" },
{ "SWAPDB", { "SWAPDB",
"index index", "index1 index2",
"Swaps two Redis databases", "Swaps two Redis databases",
8, 8,
"4.0.0" }, "4.0.0" },
@ -989,7 +1129,7 @@ struct commandHelp {
14, 14,
"5.0.0" }, "5.0.0" },
{ "XADD", { "XADD",
"key ID field string [field string ...]", "key ID field value [field value ...]",
"Appends a new entry to a stream", "Appends a new entry to a stream",
14, 14,
"5.0.0" }, "5.0.0" },
@ -1004,7 +1144,7 @@ struct commandHelp {
14, 14,
"5.0.0" }, "5.0.0" },
{ "XGROUP", { "XGROUP",
"[CREATE key groupname id-or-$] [SETID key id-or-$] [DESTROY key groupname] [DELCONSUMER key groupname consumername]", "[CREATE key groupname id-or-$] [SETID key groupname id-or-$] [DESTROY key groupname] [DELCONSUMER key groupname consumername]",
"Create, destroy, and manage consumer groups.", "Create, destroy, and manage consumer groups.",
14, 14,
"5.0.0" }, "5.0.0" },
@ -1029,12 +1169,12 @@ struct commandHelp {
14, 14,
"5.0.0" }, "5.0.0" },
{ "XREAD", { "XREAD",
"[COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]", "[COUNT count] [BLOCK milliseconds] STREAMS key [key ...] id [id ...]",
"Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.", "Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.",
14, 14,
"5.0.0" }, "5.0.0" },
{ "XREADGROUP", { "XREADGROUP",
"GROUP group consumer [COUNT count] [BLOCK milliseconds] STREAMS key [key ...] ID [ID ...]", "GROUP group consumer [COUNT count] [BLOCK milliseconds] [NOACK] STREAMS key [key ...] ID [ID ...]",
"Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block.", "Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block.",
14, 14,
"5.0.0" }, "5.0.0" },