nearSphere

Matches documents where a Geo.Point is near the target, using spherical geometry.

Unlike near, uses spherical geometry for distance calculations, so results are accurate across large areas.

Documents are returned sorted, from the closest to the furthest. For the best performance, avoid specifying an additional sort.

This operator should only be called on fields of type Geo.Point.

Example

Find all bear sightings with 1km of Périgueux:

class BearSightings(
    val _id: ObjectId,
    val location: Geo.Point,
)

sightings.find {
    BearSightings::location {
        nearSphere(
            target = Geo.Point(Longitude(0.7269), Latitude(45.1828)),
            maxDistance = 1000.0,
        )
    }
}.toList()

Indexing

This operator requires a 2dsphere index.

This operator cannot be combined with other operators requiring special indexes, like $text.

This operator is not permitted inside an aggregation pipeline. Instead, use the $geoNear stage.

External resources

• Official documentation

• YouTube tutorial

Parameters

See also