githubmirror/redis

src/commands/client-tracking.json
80 строк2 KB
Itamar Haber
Overhauls command summaries and man pages. (#11942)
29 мар 2023, 20:48
29 мар 2023, 20:480c3b8b7
{
    "TRACKING": {
        "summary": "Controls server-assisted client-side caching for the connection.",
        "complexity": "O(1). Some options may introduce additional complexity.",
        "group": "connection",
        "since": "6.0.0",
        "arity": -3,
        "container": "CLIENT",
        "function": "clientCommand",
        "command_flags": [
            "NOSCRIPT",
            "LOADING",
            "STALE",
            "SENTINEL"
        ],
        "acl_categories": [
            "CONNECTION"
        ],
        "arguments": [
            {
                "name": "status",
                "type": "oneof",
                "arguments": [
                    {
                        "name": "on",
                        "type": "pure-token",
                        "token": "ON"
                    },
                    {
                        "name": "off",
                        "type": "pure-token",
                        "token": "OFF"
                    }
                ]
            },
            {
                "token": "REDIRECT",
                "name": "client-id",
                "type": "integer",
                "optional": true
            },
            {
                "token": "PREFIX",
                "name": "prefix",
                "type": "string",
                "optional": true,
                "multiple": true,
                "multiple_token": true
            },
            {
                "name": "BCAST",
                "token": "BCAST",
                "type": "pure-token",
                "optional": true
            },
            {
                "name": "OPTIN",
                "token": "OPTIN",
                "type": "pure-token",
                "optional": true
            },
            {
                "name": "OPTOUT",
                "token": "OPTOUT",
                "type": "pure-token",
                "optional": true
            },
            {
                "name": "NOLOOP",
                "token": "NOLOOP",
                "type": "pure-token",
                "optional": true
            }
        ],
        "reply_schema": {
            "description": "if the client was successfully put into or taken out of tracking mode",
            "const": "OK"
        }
    }
}