IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› ›

Geo queries

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Geo queries

edit

Elasticsearch supports two types of geo data: geo_point fields which support lat/lon pairs, and geo_shape fields, which support points, lines, circles, polygons, multi-polygons etc.

The queries in this group are:

geo_shape query: Find document with geo-shapes which either intersect, are contained by, or do not intersect with the specified geo-shape.
geo_bounding_box query: Finds documents with geo-points that fall into the specified rectangle.
geo_distance query: Finds document with geo-points within the specified distance of a central point.
geo_polygon query: Find documents with geo-points within the specified polygon.

GeoShape Query

edit

See Geo Shape Query

Note: the geo_shape type uses Spatial4J and JTS, both of which are optional dependencies. Consequently you must add Spatial4J and JTS to your classpath in order to use this type:

<dependency>
    <groupId>org.locationtech.spatial4j</groupId>
    <artifactId>spatial4j</artifactId>
    <version>0.7</version>                        
</dependency>

<dependency>
    <groupId>org.locationtech.jts</groupId>
    <artifactId>jts-core</artifactId>
    <version>1.15.0</version>                         
    <exclusions>
        <exclusion>
            <groupId>xerces</groupId>
            <artifactId>xercesImpl</artifactId>
        </exclusion>
    </exclusions>
</dependency>

	check for updates in Maven Central
	check for updates in Maven Central

// Import ShapeRelation and ShapeBuilder
import org.elasticsearch.common.geo.ShapeRelation;
import org.elasticsearch.common.geo.builders.ShapeBuilder;

GeoShapeQueryBuilder qb = geoShapeQuery(
        "pin.location",                                      
        ShapeBuilders.newMultiPoint(                         
                new CoordinatesBuilder()
            .coordinate(0, 0)
            .coordinate(0, 10)
            .coordinate(10, 10)
            .coordinate(10, 0)
            .coordinate(0, 0)
            .build()));
qb.relation(ShapeRelation.WITHIN);

	field
	shape
	relation can be `ShapeRelation.CONTAINS`, `ShapeRelation.WITHIN`, `ShapeRelation.INTERSECTS` or `ShapeRelation.DISJOINT`

// Using pre-indexed shapes
GeoShapeQueryBuilder qb = geoShapeQuery(
            "pin.location",                                  
            "DEU",                                           
            "countries");                                    
qb.relation(ShapeRelation.WITHIN)                            
    .indexedShapeIndex("shapes")                             
    .indexedShapePath("location");

	field
	The ID of the document that containing the pre-indexed shape.
	Index type where the pre-indexed shape is.
	relation
	Name of the index where the pre-indexed shape is. Defaults to shapes.
	The field specified as path containing the pre-indexed shape. Defaults to shape.

Geo Bounding Box Query

edit

See Geo Bounding Box Query

geoBoundingBoxQuery("pin.location")                          
    .setCorners(40.73, -74.1,                                
                40.717, -73.99);

	field
	bounding box top left point
	bounding box bottom right point

Geo Distance Query

edit

See Geo Distance Query

geoDistanceQuery("pin.location")                             
    .point(40, -70)                                          
    .distance(200, DistanceUnit.KILOMETERS);

	field
	center point
	distance from center point

Geo Polygon Query

edit

See Geo Polygon Query

List<GeoPoint> points = new ArrayList<GeoPoint>();           
points.add(new GeoPoint(40, -70));
points.add(new GeoPoint(30, -80));
points.add(new GeoPoint(20, -90));
geoPolygonQuery("pin.location", points);

	add your polygon of points a document should fall within
	initialise the query with field and points

« Joining queries Specialized queries »