Geo-distance queryedit
Matches geo_point
and geo_shape
values within
a given distance of a geopoint.
Exampleedit
Assume the following documents are indexed:
response = client.indices.create( index: 'my_locations', body: { mappings: { properties: { pin: { properties: { location: { type: 'geo_point' } } } } } } ) puts response response = client.index( index: 'my_locations', id: 1, body: { pin: { location: { lat: 40.12, lon: -71.34 } } } ) puts response response = client.indices.create( index: 'my_geoshapes', body: { mappings: { properties: { pin: { properties: { location: { type: 'geo_shape' } } } } } } ) puts response response = client.index( index: 'my_geoshapes', id: 1, body: { pin: { location: { type: 'polygon', coordinates: [ [ [ 13, 51.5 ], [ 15, 51.5 ], [ 15, 54 ], [ 13, 54 ], [ 13, 51.5 ] ] ] } } } ) puts response
PUT /my_locations { "mappings": { "properties": { "pin": { "properties": { "location": { "type": "geo_point" } } } } } } PUT /my_locations/_doc/1 { "pin": { "location": { "lat": 40.12, "lon": -71.34 } } } PUT /my_geoshapes { "mappings": { "properties": { "pin": { "properties": { "location": { "type": "geo_shape" } } } } } } PUT /my_geoshapes/_doc/1 { "pin": { "location": { "type" : "polygon", "coordinates" : [[[13.0 ,51.5], [15.0, 51.5], [15.0, 54.0], [13.0, 54.0], [13.0 ,51.5]]] } } }
Use a geo_distance
filter to match geo_point
values within a specified
distance of another geopoint:
response = client.search( index: 'my_locations', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '200km', "pin.location": { lat: 40, lon: -70 } } } } } } ) puts response
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "200km", "pin.location": { "lat": 40, "lon": -70 } } } } } }
Use the same filter to match geo_shape
values within the given distance:
response = client.search( index: 'my_geoshapes', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '200km', "pin.location": { lat: 40, lon: -70 } } } } } } ) puts response
GET my_geoshapes/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "200km", "pin.location": { "lat": 40, "lon": -70 } } } } } }
To match both geo_point
and geo_shape
values, search both indices:
response = client.search( index: 'my_locations,my_geoshapes', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '200km', "pin.location": { lat: 40, lon: -70 } } } } } } ) puts response
GET my_locations,my_geoshapes/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "200km", "pin.location": { "lat": 40, "lon": -70 } } } } } }
Accepted formatsedit
In much the same way the geo_point
type can accept different
representations of the geo point, the filter can accept it as well:
Lat lon as propertiesedit
response = client.search( index: 'my_locations', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '12km', "pin.location": { lat: 40, lon: -70 } } } } } } ) puts response
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": { "lat": 40, "lon": -70 } } } } } }
Lat lon as arrayedit
Format in [lon, lat]
, note, the order of lon/lat here in order to
conform with GeoJSON.
response = client.search( index: 'my_locations', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '12km', "pin.location": [ -70, 40 ] } } } } } ) puts response
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": [ -70, 40 ] } } } } }
Lat lon as WKT stringedit
Format in Well-Known Text.
response = client.search( index: 'my_locations', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '12km', "pin.location": 'POINT (-70 40)' } } } } } ) puts response
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": "POINT (-70 40)" } } } } }
Geohashedit
response = client.search( index: 'my_locations', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '12km', "pin.location": 'drm3btev3e86' } } } } } ) puts response
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": "drm3btev3e86" } } } } }
Optionsedit
The following are options allowed on the filter:
|
The radius of the circle centred on the specified location. Points which
fall into this circle are considered to be matches. The |
|
How to compute the distance. Can either be |
|
Optional name field to identify the query |
|
Set to |
Multi location per documentedit
The geo_distance
filter can work with multiple locations / points per
document. Once a single location / point matches the filter, the
document will be included in the filter.
Ignore unmappededit
When set to true
the ignore_unmapped
option will ignore an unmapped field
and will not match any documents for this query. This can be useful when
querying multiple indexes which might have different mappings. When set to
false
(the default value) the query will throw an exception if the field
is not mapped.