summaryrefslogtreecommitdiff
path: root/examples/redis-unstable/src/commands/delex.json
blob: c41d1c4228a8eedf82f2b9bf3c4e04b6b948e031 (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
{
    "DELEX": {
        "summary": "Conditionally removes the specified key based on value or digest comparison.",
        "complexity": "O(1) for IFEQ/IFNE, O(N) for IFDEQ/IFDNE where N is the length of the string value.",
        "group": "string",
        "since": "8.4.0",
        "arity": -2,
        "function": "delexCommand",
        "get_keys_function": "delexGetKeys",
        "command_flags": [
            "WRITE",
            "FAST"
        ],
        "acl_categories": [
            "STRING"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "DELETE",
                    "VARIABLE_FLAGS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "description": "The key exists but holds a non-string value",
                    "const": "WRONGTYPE"
                },
                {
                    "description": "The key does not exist or the specified condition was not met.",
                    "const": 0
                },
                {
                    "description": "The key was deleted.",
                    "const": 1
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "condition",
                "type": "oneof",
                "optional": true,
                "arguments": [
                    {
                        "name": "ifeq-value",
                        "type": "string",
                        "token": "IFEQ"
                    },
                    {
                        "name": "ifne-value",
                        "type": "string",
                        "token": "IFNE"
                    },
                    {
                        "name": "ifdeq-digest",
                        "type": "integer",
                        "token": "IFDEQ"
                    },
                    {
                        "name": "ifdne-digest",
                        "type": "integer",
                        "token": "IFDNE"
                    }
                ]
            }
        ]
    }
}