This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Geo-grid query Geoshape query »
Elastic Docs ›Elasticsearch Guide [master] ›Query DSL ›Geo queries

Geo-polygon query

edit

Geo-polygon query

edit

Deprecated in 7.12.

Use Geoshape instead where polygons are defined in GeoJSON or Well-Known Text (WKT).

A query returning hits that only fall within a polygon of points. Here is an example:

resp = client.search(
    query={
        "bool": {
            "must": {
                "match_all": {}
            },
            "filter": {
                "geo_polygon": {
                    "person.location": {
                        "points": [
                            {
                                "lat": 40,
                                "lon": -70
                            },
                            {
                                "lat": 30,
                                "lon": -80
                            },
                            {
                                "lat": 20,
                                "lon": -90
                            }
                        ]
                    }
                }
            }
        }
    },
)
print(resp)
const response = await client.search({
  query: {
    bool: {
      must: {
        match_all: {},
      },
      filter: {
        geo_polygon: {
          "person.location": {
            points: [
              {
                lat: 40,
                lon: -70,
              },
              {
                lat: 30,
                lon: -80,
              },
              {
                lat: 20,
                lon: -90,
              },
            ],
          },
        },
      },
    },
  },
});
console.log(response);
GET /_search
{
  "query": {
    "bool": {
      "must": {
        "match_all": {}
      },
      "filter": {
        "geo_polygon": {
          "person.location": {
            "points": [
              { "lat": 40, "lon": -70 },
              { "lat": 30, "lon": -80 },
              { "lat": 20, "lon": -90 }
            ]
          }
        }
      }
    }
  }
}

Query options

edit
Option Description

_name

Optional name field to identify the filter

validation_method

Set to IGNORE_MALFORMED to accept geo points with invalid latitude or longitude, COERCE to try and infer correct latitude or longitude, or STRICT (default is STRICT).

Allowed formats

edit
Lat long as array
edit

Format as [lon, lat]

Note: the order of lon/lat here must conform with GeoJSON.

resp = client.search(
    query={
        "bool": {
            "must": {
                "match_all": {}
            },
            "filter": {
                "geo_polygon": {
                    "person.location": {
                        "points": [
                            [
                                -70,
                                40
                            ],
                            [
                                -80,
                                30
                            ],
                            [
                                -90,
                                20
                            ]
                        ]
                    }
                }
            }
        }
    },
)
print(resp)
const response = await client.search({
  query: {
    bool: {
      must: {
        match_all: {},
      },
      filter: {
        geo_polygon: {
          "person.location": {
            points: [
              [-70, 40],
              [-80, 30],
              [-90, 20],
            ],
          },
        },
      },
    },
  },
});
console.log(response);
GET /_search
{
  "query": {
    "bool": {
      "must": {
        "match_all": {}
      },
      "filter": {
        "geo_polygon": {
          "person.location": {
            "points": [
              [ -70, 40 ],
              [ -80, 30 ],
              [ -90, 20 ]
            ]
          }
        }
      }
    }
  }
}
Lat lon as string
edit

Format in lat,lon.

resp = client.search(
    query={
        "bool": {
            "must": {
                "match_all": {}
            },
            "filter": {
                "geo_polygon": {
                    "person.location": {
                        "points": [
                            "40, -70",
                            "30, -80",
                            "20, -90"
                        ]
                    }
                }
            }
        }
    },
)
print(resp)
const response = await client.search({
  query: {
    bool: {
      must: {
        match_all: {},
      },
      filter: {
        geo_polygon: {
          "person.location": {
            points: ["40, -70", "30, -80", "20, -90"],
          },
        },
      },
    },
  },
});
console.log(response);
GET /_search
{
  "query": {
    "bool": {
      "must": {
        "match_all": {}
      },
      "filter": {
        "geo_polygon": {
          "person.location": {
            "points": [
              "40, -70",
              "30, -80",
              "20, -90"
            ]
          }
        }
      }
    }
  }
}
Geohash
edit
resp = client.search(
    query={
        "bool": {
            "must": {
                "match_all": {}
            },
            "filter": {
                "geo_polygon": {
                    "person.location": {
                        "points": [
                            "drn5x1g8cu2y",
                            "30, -80",
                            "20, -90"
                        ]
                    }
                }
            }
        }
    },
)
print(resp)
const response = await client.search({
  query: {
    bool: {
      must: {
        match_all: {},
      },
      filter: {
        geo_polygon: {
          "person.location": {
            points: ["drn5x1g8cu2y", "30, -80", "20, -90"],
          },
        },
      },
    },
  },
});
console.log(response);
GET /_search
{
  "query": {
    "bool": {
      "must": {
        "match_all": {}
      },
      "filter": {
        "geo_polygon": {
          "person.location": {
            "points": [
              "drn5x1g8cu2y",
              "30, -80",
              "20, -90"
            ]
          }
        }
      }
    }
  }
}

geo_point type

edit

The query requires the geo_point type to be set on the relevant field.

Ignore unmapped

edit

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.

« Geo-grid query Geoshape query »