summaryrefslogtreecommitdiffstats
path: root/src/commands/client-unblock.json
blob: d028f471490391eb4b957531991109731ab93064 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
    "UNBLOCK": {
        "summary": "Unblocks a client blocked by a blocking command from a different connection.",
        "complexity": "O(log N) where N is the number of client connections",
        "group": "connection",
        "since": "5.0.0",
        "arity": -3,
        "container": "CLIENT",
        "function": "clientCommand",
        "command_flags": [
            "ADMIN",
            "NOSCRIPT",
            "LOADING",
            "STALE",
            "SENTINEL"
        ],
        "acl_categories": [
            "CONNECTION"
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "const": 0,
                    "description": "if the client was unblocked successfully"
                },
                {
                    "const": 1,
                    "description": "if the client wasn't unblocked"
                }
            ]
        },
        "arguments": [
            {
                "name": "client-id",
                "type": "integer"
            },
            {
                "name": "unblock-type",
                "type": "oneof",
                "optional": true,
                "arguments": [
                    {
                        "name": "timeout",
                        "type": "pure-token",
                        "token": "TIMEOUT"
                    },
                    {
                        "name": "error",
                        "type": "pure-token",
                        "token": "ERROR"
                    }
                ]
            }
        ]
    }
}