githubmirror/redis

src/commands/client-trackinginfo.json
80 строк3 KB
Itamar Haber
Overhauls command summaries and man pages. (#11942)
29 мар 2023, 20:48
29 мар 2023, 20:480c3b8b7
{
    "TRACKINGINFO": {
        "summary": "Returns information about server-assisted client-side caching for the connection.",
        "complexity": "O(1)",
        "group": "connection",
        "since": "6.2.0",
        "arity": 2,
        "container": "CLIENT",
        "function": "clientCommand",
        "command_flags": [
            "NOSCRIPT",
            "LOADING",
            "STALE",
            "SENTINEL"
        ],
        "acl_categories": [
            "CONNECTION"
        ],
        "reply_schema": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "flags": {
                    "type": "array",
                    "items": {
                        "oneOf": [
                            {
                                "const": "off",
                                "description": "The connection isn't using server assisted client side caching."
                            },
                            {
                                "const": "on",
                                "description": "Server assisted client side caching is enabled for the connection."
                            },
                            {
                                "const": "bcast",
                                "description": "The client uses broadcasting mode."
                            },
                            {
                                "const": "optin",
                                "description": "The client does not cache keys by default."
                            },
                            {
                                "const": "optout",
                                "description": "The client caches keys by default."
                            },
                            {
                                "const": "caching-yes",
                                "description": "The next command will cache keys (exists only together with optin)."
                            },
                            {
                                "const": "caching-no",
                                "description": "The next command won't cache keys (exists only together with optout)."
                            },
                            {
                                "const": "noloop",
                                "description": "The client isn't notified about keys modified by itself."
                            },
                            {
                                "const": "broken_redirect",
                                "description": "The client ID used for redirection isn't valid anymore."
                            }
                        ]
                    }
                },
                "redirect": {
                    "type": "integer",
                    "description": "The client ID used for notifications redirection, or -1 when none."
                },
                "prefixes": {
                    "type": "array",
                    "description": "List of key prefixes for which notifications are sent to the client.",
                    "items": {
                        "type": "string"
                    }
                }
            }
        }
    }
}