Unverified Commit 0c3b8b7e authored by Itamar Haber's avatar Itamar Haber Committed by GitHub
Browse files

Overhauls command summaries and man pages. (#11942)

This is an attempt to normalize/formalize command summaries.

Main actions performed:

* Starts with the continuation of the phrase "The XXXX command, when called, ..." for user commands.
* Starts with "An internal command...", "A container command...", etc... when applicable.
* Always uses periods.
* Refrains from referring to other commands. If this is needed, backquotes should be used for command names.
* Tries to be very clear about the data type when applicable.
* Tries to mention additional effects, e.g. "The key is created if it doesn't exist" and "The set is deleted if the last member is removed."
* Prefers being terse over verbose.
* Tries to be consistent.
parent cb171786
{ {
"DISCARD": { "DISCARD": {
"summary": "Discard all commands issued after MULTI", "summary": "Discards a transaction.",
"complexity": "O(N), when N is the number of queued commands", "complexity": "O(N), when N is the number of queued commands",
"group": "transactions", "group": "transactions",
"since": "2.0.0", "since": "2.0.0",
......
{ {
"DUMP": { "DUMP": {
"summary": "Return a serialized version of the value stored at the specified key.", "summary": "Returns a serialized representation of the value stored at a key.",
"complexity": "O(1) to access the key and additional O(N*M) to serialize it, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1*M) where M is small, so simply O(1).", "complexity": "O(1) to access the key and additional O(N*M) to serialize it, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1*M) where M is small, so simply O(1).",
"group": "generic", "group": "generic",
"since": "2.6.0", "since": "2.6.0",
......
{ {
"ECHO": { "ECHO": {
"summary": "Echo the given string", "summary": "Returns the given string.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "connection", "group": "connection",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"EVAL": { "EVAL": {
"summary": "Execute a Lua script server side", "summary": "Executes a server-side Lua script.",
"complexity": "Depends on the script that is executed.", "complexity": "Depends on the script that is executed.",
"group": "scripting", "group": "scripting",
"since": "2.6.0", "since": "2.6.0",
......
{ {
"EVAL_RO": { "EVAL_RO": {
"summary": "Execute a read-only Lua script server side", "summary": "Executes a read-only server-side Lua script.",
"complexity": "Depends on the script that is executed.", "complexity": "Depends on the script that is executed.",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"EVALSHA": { "EVALSHA": {
"summary": "Execute a Lua script server side", "summary": "Executes a server-side Lua script by SHA1 digest.",
"complexity": "Depends on the script that is executed.", "complexity": "Depends on the script that is executed.",
"group": "scripting", "group": "scripting",
"since": "2.6.0", "since": "2.6.0",
......
{ {
"EVALSHA_RO": { "EVALSHA_RO": {
"summary": "Execute a read-only Lua script server side", "summary": "Executes a read-only server-side Lua script by SHA1 digest.",
"complexity": "Depends on the script that is executed.", "complexity": "Depends on the script that is executed.",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"EXEC": { "EXEC": {
"summary": "Execute all commands issued after MULTI", "summary": "Executes all commands in a transaction.",
"complexity": "Depends on commands in the transaction", "complexity": "Depends on commands in the transaction",
"group": "transactions", "group": "transactions",
"since": "1.2.0", "since": "1.2.0",
......
{ {
"EXISTS": { "EXISTS": {
"summary": "Determine if a key exists", "summary": "Determines whether one or more keys exist.",
"complexity": "O(N) where N is the number of keys to check.", "complexity": "O(N) where N is the number of keys to check.",
"group": "generic", "group": "generic",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"EXPIRE": { "EXPIRE": {
"summary": "Set a key's time to live in seconds", "summary": "Sets the expiration time of a key in seconds.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"EXPIREAT": { "EXPIREAT": {
"summary": "Set the expiration for a key as a UNIX timestamp", "summary": "Sets the expiration time of a key to a Unix timestamp.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "1.2.0", "since": "1.2.0",
......
{ {
"EXPIRETIME": { "EXPIRETIME": {
"summary": "Get the expiration Unix timestamp for a key", "summary": "Returns the expiration time of a key as a Unix timestamp.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "generic", "group": "generic",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"FAILOVER": { "FAILOVER": {
"summary": "Start a coordinated failover between this server and one of its replicas.", "summary": "Starts a coordinated failover from a server to one of its replicas.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "server", "group": "server",
"since": "6.2.0", "since": "6.2.0",
......
{ {
"FCALL": { "FCALL": {
"summary": "Invoke a function", "summary": "Invokes a function.",
"complexity": "Depends on the function that is executed.", "complexity": "Depends on the function that is executed.",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"FCALL_RO": { "FCALL_RO": {
"summary": "Invoke a read-only function", "summary": "Invokes a read-only function.",
"complexity": "Depends on the function that is executed.", "complexity": "Depends on the function that is executed.",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"FLUSHALL": { "FLUSHALL": {
"summary": "Remove all keys from all databases", "summary": "Removes all keys from all databases.",
"complexity": "O(N) where N is the total number of keys in all databases", "complexity": "O(N) where N is the total number of keys in all databases",
"group": "server", "group": "server",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"FLUSHDB": { "FLUSHDB": {
"summary": "Remove all keys from the current database", "summary": "Remove all keys from the current database.",
"complexity": "O(N) where N is the number of keys in the selected database", "complexity": "O(N) where N is the number of keys in the selected database",
"group": "server", "group": "server",
"since": "1.0.0", "since": "1.0.0",
......
{ {
"DELETE": { "DELETE": {
"summary": "Delete a function by name", "summary": "Deletes a library and its functions.",
"complexity": "O(1)", "complexity": "O(1)",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"DUMP": { "DUMP": {
"summary": "Dump all functions into a serialized binary payload", "summary": "Dumps all libraries into a serialized binary payload.",
"complexity": "O(N) where N is the number of functions", "complexity": "O(N) where N is the number of functions",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
{ {
"FLUSH": { "FLUSH": {
"summary": "Deleting all functions", "summary": "Deletes all libraries and functions.",
"complexity": "O(N) where N is the number of functions deleted", "complexity": "O(N) where N is the number of functions deleted",
"group": "scripting", "group": "scripting",
"since": "7.0.0", "since": "7.0.0",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment