mirror of
https://github.com/redis/redis.git
synced 2026-04-21 03:01:35 -04:00
0c3b8b7e90
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.
55 lines
1.3 KiB
JSON
55 lines
1.3 KiB
JSON
{
|
|
"PAUSE": {
|
|
"summary": "Suspends commands processing.",
|
|
"complexity": "O(1)",
|
|
"group": "connection",
|
|
"since": "3.0.0",
|
|
"arity": -3,
|
|
"container": "CLIENT",
|
|
"function": "clientCommand",
|
|
"history": [
|
|
[
|
|
"6.2.0",
|
|
"`CLIENT PAUSE WRITE` mode added along with the `mode` option."
|
|
]
|
|
],
|
|
"command_flags": [
|
|
"ADMIN",
|
|
"NOSCRIPT",
|
|
"LOADING",
|
|
"STALE",
|
|
"SENTINEL"
|
|
],
|
|
"acl_categories": [
|
|
"CONNECTION"
|
|
],
|
|
"arguments": [
|
|
{
|
|
"name": "timeout",
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"name": "mode",
|
|
"type": "oneof",
|
|
"optional": true,
|
|
"since": "6.2.0",
|
|
"arguments": [
|
|
{
|
|
"name": "write",
|
|
"type": "pure-token",
|
|
"token": "WRITE"
|
|
},
|
|
{
|
|
"name": "all",
|
|
"type": "pure-token",
|
|
"token": "ALL"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"reply_schema": {
|
|
"const": "OK"
|
|
}
|
|
}
|
|
}
|