Geo-distance query
editGeo-distance query
editMatches geo_point
and geo_shape
values within
a given distance of a geopoint.
Example
editAssume the following documents are indexed:
resp = client.indices.create( index="my_locations", mappings={ "properties": { "pin": { "properties": { "location": { "type": "geo_point" } } } } }, ) print(resp) resp1 = client.index( index="my_locations", id="1", document={ "pin": { "location": { "lat": 40.12, "lon": -71.34 } } }, ) print(resp1) resp2 = client.indices.create( index="my_geoshapes", mappings={ "properties": { "pin": { "properties": { "location": { "type": "geo_shape" } } } } }, ) print(resp2) resp3 = client.index( index="my_geoshapes", id="1", document={ "pin": { "location": { "type": "polygon", "coordinates": [ [ [ 13, 51.5 ], [ 15, 51.5 ], [ 15, 54 ], [ 13, 54 ], [ 13, 51.5 ] ] ] } } }, ) print(resp3)
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
const response = await client.indices.create({ index: "my_locations", mappings: { properties: { pin: { properties: { location: { type: "geo_point", }, }, }, }, }, }); console.log(response); const response1 = await client.index({ index: "my_locations", id: 1, document: { pin: { location: { lat: 40.12, lon: -71.34, }, }, }, }); console.log(response1); const response2 = await client.indices.create({ index: "my_geoshapes", mappings: { properties: { pin: { properties: { location: { type: "geo_shape", }, }, }, }, }, }); console.log(response2); const response3 = await client.index({ index: "my_geoshapes", id: 1, document: { pin: { location: { type: "polygon", coordinates: [ [ [13, 51.5], [15, 51.5], [15, 54], [13, 54], [13, 51.5], ], ], }, }, }, }); console.log(response3);
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:
resp = client.search( index="my_locations", query={ "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "200km", "pin.location": { "lat": 40, "lon": -70 } } } } }, ) print(resp)
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
const response = await client.search({ index: "my_locations", query: { bool: { must: { match_all: {}, }, filter: { geo_distance: { distance: "200km", "pin.location": { lat: 40, lon: -70, }, }, }, }, }, }); console.log(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:
resp = client.search( index="my_geoshapes", query={ "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "200km", "pin.location": { "lat": 40, "lon": -70 } } } } }, ) print(resp)
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
const response = await client.search({ index: "my_geoshapes", query: { bool: { must: { match_all: {}, }, filter: { geo_distance: { distance: "200km", "pin.location": { lat: 40, lon: -70, }, }, }, }, }, }); console.log(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:
resp = client.search( index="my_locations,my_geoshapes", query={ "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "200km", "pin.location": { "lat": 40, "lon": -70 } } } } }, ) print(resp)
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
const response = await client.search({ index: "my_locations,my_geoshapes", query: { bool: { must: { match_all: {}, }, filter: { geo_distance: { distance: "200km", "pin.location": { lat: 40, lon: -70, }, }, }, }, }, }); console.log(response);
GET my_locations,my_geoshapes/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "200km", "pin.location": { "lat": 40, "lon": -70 } } } } } }
Accepted formats
editIn 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 properties
editresp = client.search( index="my_locations", query={ "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": { "lat": 40, "lon": -70 } } } } }, ) print(resp)
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
const response = await client.search({ index: "my_locations", query: { bool: { must: { match_all: {}, }, filter: { geo_distance: { distance: "12km", "pin.location": { lat: 40, lon: -70, }, }, }, }, }, }); console.log(response);
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": { "lat": 40, "lon": -70 } } } } } }
Lat lon as array
editFormat in [lon, lat]
, note, the order of lon/lat here in order to
conform with GeoJSON.
resp = client.search( index="my_locations", query={ "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": [ -70, 40 ] } } } }, ) print(resp)
response = client.search( index: 'my_locations', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '12km', 'pin.location' => [ -70, 40 ] } } } } } ) puts response
const response = await client.search({ index: "my_locations", query: { bool: { must: { match_all: {}, }, filter: { geo_distance: { distance: "12km", "pin.location": [-70, 40], }, }, }, }, }); console.log(response);
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": [ -70, 40 ] } } } } }
Lat lon as WKT string
editFormat in Well-Known Text.
resp = client.search( index="my_locations", query={ "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": "POINT (-70 40)" } } } }, ) print(resp)
response = client.search( index: 'my_locations', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '12km', 'pin.location' => 'POINT (-70 40)' } } } } } ) puts response
const response = await client.search({ index: "my_locations", query: { bool: { must: { match_all: {}, }, filter: { geo_distance: { distance: "12km", "pin.location": "POINT (-70 40)", }, }, }, }, }); console.log(response);
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": "POINT (-70 40)" } } } } }
Geohash
editresp = client.search( index="my_locations", query={ "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": "drm3btev3e86" } } } }, ) print(resp)
response = client.search( index: 'my_locations', body: { query: { bool: { must: { match_all: {} }, filter: { geo_distance: { distance: '12km', 'pin.location' => 'drm3btev3e86' } } } } } ) puts response
const response = await client.search({ index: "my_locations", query: { bool: { must: { match_all: {}, }, filter: { geo_distance: { distance: "12km", "pin.location": "drm3btev3e86", }, }, }, }, }); console.log(response);
GET /my_locations/_search { "query": { "bool": { "must": { "match_all": {} }, "filter": { "geo_distance": { "distance": "12km", "pin.location": "drm3btev3e86" } } } } }
Options
editThe 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 document
editThe 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 unmapped
editWhen 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.