githubmirror/redis

src/commands/failover.json

54 строки1 KB

Itamar Haber

Overhauls command summaries and man pages. (#11942)

29 мар 2023, 20:48

29 мар 2023, 20:480c3b8b7

{
    "FAILOVER": {
        "summary": "Starts a coordinated failover from a server to one of its replicas.",
        "complexity": "O(1)",
        "group": "server",
        "since": "6.2.0",
        "arity": -1,
        "function": "failoverCommand",
        "command_flags": [
            "ADMIN",
            "NOSCRIPT",
            "STALE"
        ],
        "reply_schema": {
            "const": "OK"
        },
        "arguments": [
            {
                "name": "target",
                "token": "TO",
                "type": "block",
                "optional": true,
                "arguments": [
                    {
                        "name": "host",
                        "type": "string"
                    },
                    {
                        "name": "port",
                        "type": "integer"
                    },
                    {
                        "token": "FORCE",
                        "name": "force",
                        "type": "pure-token",
                        "optional": true
                    }
                ]
            },
            {
                "token": "ABORT",
                "name": "abort",
                "type": "pure-token",
                "optional": true
            },
            {
                "token": "TIMEOUT",
                "name": "milliseconds",
                "type": "integer",
                "optional": true
            }
        ]
    }
}