futriix/src/commands/command-getkeys.json
Itamar Haber 0c3b8b7e90
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.
2023-03-29 20:48:59 +03:00

40 lines
1.0 KiB
JSON

{
"GETKEYS": {
"summary": "Extracts the key names from an arbitrary command.",
"complexity": "O(N) where N is the number of arguments to the command",
"group": "server",
"since": "2.8.13",
"arity": -3,
"container": "COMMAND",
"function": "commandGetKeysCommand",
"command_flags": [
"LOADING",
"STALE",
"SENTINEL"
],
"acl_categories": [
"CONNECTION"
],
"reply_schema": {
"description": "List of keys from the given Redis command.",
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"arguments": [
{
"name": "command",
"type": "string"
},
{
"name": "arg",
"type": "string",
"optional": true,
"multiple": true
}
]
}
}