summaryrefslogtreecommitdiff
path: root/src/commands/geosearchstore.json
blob: dfbdaaaeca302fd4f1ca8103dfe95177279d51a8 (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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
{
    "GEOSEARCHSTORE": {
        "summary": "Queries a geospatial index for members inside an area of a box or a circle, optionally stores the result.",
        "complexity": "O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape",
        "group": "geo",
        "since": "6.2.0",
        "arity": -8,
        "function": "geosearchstoreCommand",
        "history": [
            [
                "7.0.0",
                "Added support for uppercase unit names."
            ]
        ],
        "command_flags": [
            "WRITE",
            "DENYOOM"
        ],
        "acl_categories": [
            "GEO"
        ],
        "key_specs": [
            {
                "flags": [
                    "OW",
                    "UPDATE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            },
            {
                "flags": [
                    "RO",
                    "ACCESS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 2
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "arguments": [
            {
                "name": "destination",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "source",
                "type": "key",
                "key_spec_index": 1
            },
            {
                "name": "from",
                "type": "oneof",
                "arguments": [
                    {
                        "token": "FROMMEMBER",
                        "name": "member",
                        "type": "string"
                    },
                    {
                        "token": "FROMLONLAT",
                        "name": "fromlonlat",
                        "type": "block",
                        "arguments": [
                            {
                                "name": "longitude",
                                "type": "double"
                            },
                            {
                                "name": "latitude",
                                "type": "double"
                            }
                        ]
                    }
                ]
            },
            {
                "name": "by",
                "type": "oneof",
                "arguments": [
                    {
                        "name": "circle",
                        "type": "block",
                        "arguments": [
                            {
                                "token": "BYRADIUS",
                                "name": "radius",
                                "type": "double"
                            },
                            {
                                "name": "unit",
                                "type": "oneof",
                                "arguments": [
                                    {
                                        "name": "m",
                                        "type": "pure-token",
                                        "token": "m"
                                    },
                                    {
                                        "name": "km",
                                        "type": "pure-token",
                                        "token": "km"
                                    },
                                    {
                                        "name": "ft",
                                        "type": "pure-token",
                                        "token": "ft"
                                    },
                                    {
                                        "name": "mi",
                                        "type": "pure-token",
                                        "token": "mi"
                                    }
                                ]
                            }
                        ]
                    },
                    {
                        "name": "box",
                        "type": "block",
                        "arguments": [
                            {
                                "token": "BYBOX",
                                "name": "width",
                                "type": "double"
                            },
                            {
                                "name": "height",
                                "type": "double"
                            },
                            {
                                "name": "unit",
                                "type": "oneof",
                                "arguments": [
                                    {
                                        "name": "m",
                                        "type": "pure-token",
                                        "token": "m"
                                    },
                                    {
                                        "name": "km",
                                        "type": "pure-token",
                                        "token": "km"
                                    },
                                    {
                                        "name": "ft",
                                        "type": "pure-token",
                                        "token": "ft"
                                    },
                                    {
                                        "name": "mi",
                                        "type": "pure-token",
                                        "token": "mi"
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            {
                "name": "order",
                "type": "oneof",
                "optional": true,
                "arguments": [
                    {
                        "name": "asc",
                        "type": "pure-token",
                        "token": "ASC"
                    },
                    {
                        "name": "desc",
                        "type": "pure-token",
                        "token": "DESC"
                    }
                ]
            },
            {
                "name": "count-block",
                "type": "block",
                "optional": true,
                "arguments": [
                    {
                        "token": "COUNT",
                        "name": "count",
                        "type": "integer"
                    },
                    {
                        "name": "any",
                        "token": "ANY",
                        "type": "pure-token",
                        "optional": true
                    }
                ]
            },
            {
                "name": "storedist",
                "token": "STOREDIST",
                "type": "pure-token",
                "optional": true
            }
        ],
        "reply_schema": {
            "description": "the number of elements in the resulting set",
            "type": "integer"
        }
    }
}