summaryrefslogtreecommitdiffstats
path: root/src/commands/xadd.json
blob: e8914ebb36359d5263cd90b1d2b5eb24eb21bde1 (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
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
{
    "XADD": {
        "summary": "Appends a new entry to a stream",
        "complexity": "O(1) when adding a new entry, O(N) when trimming where N being the number of entries evicted.",
        "group": "stream",
        "since": "5.0.0",
        "arity": -5,
        "function": "xaddCommand",
        "history": [
            [
                "6.2.0",
                "Added the `NOMKSTREAM` option, `MINID` trimming strategy and the `LIMIT` option."
            ],
            [
                "7.0.0",
                "Added support for the `<ms>-*` explicit ID form."
            ]
        ],
        "command_flags": [
            "WRITE",
            "DENYOOM",
            "FAST"
        ],
        "acl_categories": [
            "STREAM"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT"
        ],
        "key_specs": [
            {
                "notes": "UPDATE instead of INSERT because of the optional trimming feature",
                "flags": [
                    "RW",
                    "UPDATE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "token": "NOMKSTREAM",
                "name": "nomkstream",
                "type": "pure-token",
                "optional": true,
                "since": "6.2.0"
            },
            {
                "name": "trim",
                "type": "block",
                "optional": true,
                "arguments": [
                    {
                        "name": "strategy",
                        "type": "oneof",
                        "arguments": [
                            {
                                "name": "maxlen",
                                "type": "pure-token",
                                "token": "MAXLEN"
                            },
                            {
                                "name": "minid",
                                "type": "pure-token",
                                "token": "MINID",
                                "since": "6.2.0"
                            }
                        ]
                    },
                    {
                        "name": "operator",
                        "type": "oneof",
                        "optional": true,
                        "arguments": [
                            {
                                "name": "equal",
                                "type": "pure-token",
                                "token": "="
                            },
                            {
                                "name": "approximately",
                                "type": "pure-token",
                                "token": "~"
                            }
                        ]
                    },
                    {
                        "name": "threshold",
                        "type": "string"
                    },
                    {
                        "token": "LIMIT",
                        "name": "count",
                        "type": "integer",
                        "optional": true,
                        "since": "6.2.0"
                    }
                ]
            },
            {
                "name": "id_or_auto",
                "type": "oneof",
                "arguments": [
                    {
                        "name": "auto_id",
                        "type": "pure-token",
                        "token": "*"
                    },
                    {
                        "name": "ID",
                        "type": "string"
                    }
                ]
            },
            {
                "name": "field_value",
                "type": "block",
                "multiple": true,
                "arguments": [
                    {
                        "name": "field",
                        "type": "string"
                    },
                    {
                        "name": "value",
                        "type": "string"
                    }
                ]
            }
        ]
    }
}