githubmirror/redis

src/commands/client-pause.json

54 строки1 KB

Itamar Haber

Overhauls command summaries and man pages. (#11942)

29 мар 2023, 20:48

29 мар 2023, 20:480c3b8b7

{
    "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"
        }
    }
}