Geo: Filter by distance based on location

[kimchy]

The ability to define a query DSL filter, allowing to include only hits that exists within a specific distance from a geo point. Assuming the following indexed json:

{
    "pin" : {
        "location" : {
            "lat" : 40.12,
            "lon" : -71.34
        }
    }
}

Then the following simple query can be executed with a geo_distance filter:

{
    "filtered" : {
        "query" : {
            "match_all" : {}
        },
        "filter" : {
            "geo_distance" : {
                "distance" : "12km"
                "pin.location" : {
                    "lat" : 40,
                    "lon" : -70
                }
            }
        }
    }
}

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

{
    "filtered" : {
        "query" : {
            "match_all" : {}
        },
        "filter" : {
            "geo_distance" : {
                "distance" : "12km"
                "pin.location" : {
                    "lat" : 40,
                    "lon" : -70
                }
            }
        }
    }
}

Lat Lon As Array

{
    "filtered" : {
        "query" : {
            "match_all" : {}
        },
        "filter" : {
            "geo_distance" : {
                "distance" : "12km"
                "pin.location" : [40, -70]
            }
        }
    }
}

Lat Lon As String

{
    "filtered" : {
        "query" : {
            "match_all" : {}
        },
        "filter" : {
            "geo_distance" : {
                "distance" : "12km"
                "pin.location" : "40,-70"
            }
        }
    }
}

Geohash

{
    "filtered" : {
        "query" : {
            "match_all" : {}
        },
        "filter" : {
            "geo_distance" : {
                "distance" : "12km"
                "pin.location" : "drm3btev3e86"
            }
        }
    }
}

Options

The following are options allowed on the filter:

• distance: The distance to include hits in the filter. The distance can be a numeric value, and then the distance_unit (either mi/miles or km can be set) controlling the unit. Or a single string with the unit as well.
• distance_type: How to compute the distance. Can either be arc (better precision) or plane (faster). Defaults to arc.

geo_point Type

The filter does not require the geo_point type to be set. It assumes that the location object indexed includes a lat and lon numeric values. The geo_point type follows these rules and allows for more flexible indexing options / structure, but is not required.

Multi Location Per Document

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.

[kimchy]

implemented.

[mikenereson]

In examples, missing , after "distance" : "12km"

[gauraangkhurana]

What goes before this json request ?

I tried this 'geo_distance' filter query about 20 times but it gives me this error.

My Code :

`curl` -XGET localhost:9200/resume/_search -d  ' { {
    "filtered" : {
        "query" : {
            "match_all" : {}
        },
        "filter" : {
            "geo_distance" : {
                "distance" : "12km"
                "pin.location" : {
                    "lat" : 40,
                    "lon" : -70
                }
            }
        }
    }
}

The error produced is

{"error":{"root_cause":[{"type":"parsing_exception","reason":"Unknown key for a START_OBJECT in [filtered].","line":1,"col":19}],"type":"parsing_exception","reason":"Unknown key for a START_OBJECT in [filtered].","line":1,"col":19},"status":400}

Kindly help me.

[dadoonet]

Ask questions on discuss.elastic.co

Filtered query has been removed in 5.0. See breaking changes in doc