src/commands/set.json


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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

{
    "SET": {
        "summary": "Sets the string value of a key, ignoring its type. The key is created if it doesn't exist.",
        "complexity": "O(1)",
        "group": "string",
        "since": "1.0.0",
        "arity": -3,
        "function": "setCommand",
        "get_keys_function": "setGetKeys",
        "history": [
            [
                "2.6.12",
                "Added the `EX`, `PX`, `NX` and `XX` options."
            ],
            [
                "6.0.0",
                "Added the `KEEPTTL` option."
            ],
            [
                "6.2.0",
                "Added the `GET`, `EXAT` and `PXAT` option."
            ],
            [
                "7.0.0",
                "Allowed the `NX` and `GET` options to be used together."
            ]
        ],
        "command_flags": [
            "WRITE",
            "DENYOOM"
        ],
        "acl_categories": [
            "STRING"
        ],
        "key_specs": [
            {
                "notes": "RW and ACCESS due to the optional `GET` argument",
                "flags": [
                    "RW",
                    "ACCESS",
                    "UPDATE",
                    "VARIABLE_FLAGS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "anyOf":[
                {
                    "description": "`GET` not given: Operation was aborted (conflict with one of the `XX`/`NX` options).",
                    "type": "null"
                },
                {
                    "description": "`GET` not given: The key was set.",
                    "const": "OK"
                },
                {
                    "description": "`GET` given: The key didn't exist before the `SET`",
                    "type": "null"
                },
                {
                    "description": "`GET` given: The previous value of the key",
                    "type": "string"
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "value",
                "type": "string"
            },
            {
                "name": "condition",
                "type": "oneof",
                "optional": true,
                "since": "2.6.12",
                "arguments": [
                    {
                        "name": "nx",
                        "type": "pure-token",
                        "token": "NX"
                    },
                    {
                        "name": "xx",
                        "type": "pure-token",
                        "token": "XX"
                    }
                ]
            },
            {
                "name": "get",
                "token": "GET",
                "type": "pure-token",
                "optional": true,
                "since": "6.2.0"
            },
            {
                "name": "expiration",
                "type": "oneof",
                "optional": true,
                "arguments": [
                    {
                        "name": "seconds",
                        "type": "integer",
                        "token": "EX",
                        "since": "2.6.12"
                    },
                    {
                        "name": "milliseconds",
                        "type": "integer",
                        "token": "PX",
                        "since": "2.6.12"
                    },
                    {
                        "name": "unix-time-seconds",
                        "type": "unix-time",
                        "token": "EXAT",
                        "since": "6.2.0"
                    },
                    {
                        "name": "unix-time-milliseconds",
                        "type": "unix-time",
                        "token": "PXAT",
                        "since": "6.2.0"
                    },
                    {
                        "name": "keepttl",
                        "type": "pure-token",
                        "token": "KEEPTTL",
                        "since": "6.0.0"
                    }
                ]
            }
        ]
    }
}