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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
[[search-facets-geo-distance-facet]]
=== Geo Distance Facets
The geo_distance facet is a facet providing information for ranges of
distances from a provided geo_point including count of the number of
hits that fall within each range, and aggregation information (like
total).
Assuming the following sample doc:
[source,js]
--------------------------------------------------
{
"pin" : {
"location" : {
"lat" : 40.12,
"lon" : -71.34
}
}
}
--------------------------------------------------
Here is an example that create a `geo_distance` facet from a
`pin.location` of 40,-70, and a set of ranges:
[source,js]
--------------------------------------------------
{
"query" : {
"match_all" : {}
},
"facets" : {
"geo1" : {
"geo_distance" : {
"pin.location" : {
"lat" : 40,
"lon" : -70
},
"ranges" : [
{ "to" : 10 },
{ "from" : 10, "to" : 20 },
{ "from" : 20, "to" : 100 },
{ "from" : 100 }
]
}
}
}
}
--------------------------------------------------
==== Accepted Formats
In much the same way the geo_point type can accept different
representation of the geo point, the filter can accept it as well:
===== Lat Lon As Properties
[source,js]
--------------------------------------------------
{
"query" : {
"match_all" : {}
},
"facets" : {
"geo1" : {
"geo_distance" : {
"pin.location" : {
"lat" : 40,
"lon" : -70
},
"ranges" : [
{ "to" : 10 },
{ "from" : 10, "to" : 20 },
{ "from" : 20, "to" : 100 },
{ "from" : 100 }
]
}
}
}
}
--------------------------------------------------
===== Lat Lon As Array
Format in `[lon, lat]`, note, the order of lon/lat here in order to
conform with http://geojson.org/[GeoJSON].
[source,js]
--------------------------------------------------
{
"query" : {
"match_all" : {}
},
"facets" : {
"geo1" : {
"geo_distance" : {
"pin.location" : [40, -70],
"ranges" : [
{ "to" : 10 },
{ "from" : 10, "to" : 20 },
{ "from" : 20, "to" : 100 },
{ "from" : 100 }
]
}
}
}
}
--------------------------------------------------
===== Lat Lon As String
Format in `lat,lon`.
[source,js]
--------------------------------------------------
{
"query" : {
"match_all" : {}
},
"facets" : {
"geo1" : {
"geo_distance" : {
"pin.location" : "40, -70",
"ranges" : [
{ "to" : 10 },
{ "from" : 10, "to" : 20 },
{ "from" : 20, "to" : 100 },
{ "from" : 100 }
]
}
}
}
}
--------------------------------------------------
===== Geohash
[source,js]
--------------------------------------------------
{
"query" : {
"match_all" : {}
},
"facets" : {
"geo1" : {
"geo_distance" : {
"pin.location" : "drm3btev3e86",
"ranges" : [
{ "to" : 10 },
{ "from" : 10, "to" : 20 },
{ "from" : 20, "to" : 100 },
{ "from" : 100 }
]
}
}
}
}
--------------------------------------------------
==== Ranges
When a `to` or `from` are not set, they are assumed to be unbounded.
Ranges are allowed to overlap, basically, each range is treated by
itself.
==== Options
[cols="<,<",options="header",]
|=======================================================================
|Option |Description
|`unit` |The unit the ranges are provided in. Defaults to `km`. Can also
be `mi`, `miles`, `in`, `inch`, `yd`, `yards`, `ft`, `feet`, `kilometers`, `mm`, `millimeters`, `cm`, `centimeters`, `m` or `meters`.
|`distance_type` |How to compute the distance. Can either be `arc`
(better precision), `sloppy_arc` (faster) or `plane` (fastest). Defaults to `sloppy_arc`.
|=======================================================================
==== Value Options
On top of the count of hits falling within each range, aggregated data
can be provided (total) as well. By default, the aggregated data will
simply use the distance calculated, but the value can be extracted
either using a different numeric field, or a script. Here is an example
of using a different numeric field:
[source,js]
--------------------------------------------------
{
"query" : {
"match_all" : {}
},
"facets" : {
"geo1" : {
"geo_distance" : {
"pin.location" : "drm3btev3e86",
"value_field" : "num1",
"ranges" : [
{ "to" : 10 },
{ "from" : 10, "to" : 20 },
{ "from" : 20, "to" : 100 },
{ "from" : 100 }
]
}
}
}
}
--------------------------------------------------
And here is an example of using a script:
[source,js]
--------------------------------------------------
{
"query" : {
"match_all" : {}
},
"facets" : {
"geo1" : {
"geo_distance" : {
"pin.location" : "drm3btev3e86",
"value_script" : "doc['num1'].value * factor",
"params" : {
"factor" : 5
}
"ranges" : [
{ "to" : 10 },
{ "from" : 10, "to" : 20 },
{ "from" : 20, "to" : 100 },
{ "from" : 100 }
]
}
}
}
}
--------------------------------------------------
Note the params option, allowing to pass parameters to the script
(resulting in faster script execution instead of providing the values
within the script each time).
.`geo_point` Type
[NOTE]
--
The facet *requires* the `geo_point` type to be set on the relevant
field.
--
.Multi Location Per Document
[NOTE]
--
The facet can work with multiple locations per document.
--
|
