$geoNear (agregación)

Definición

$geoNear

Emite documentos en orden de más cercano a más lejano desde un punto especificado.

Nota

MongoDB remueve las opciones limit y num para la etapa $geoNear además del límite por defecto de 100 documentos. Para limitar los resultados de $geoNear, utiliza la etapa $geoNear con el $limit etapa.

La etapa $geoNear tiene la siguiente forma de prototipo:

{ $geoNear: { <geoNear options> } }

El operador $geoNear acepta un documento que contiene las siguientes opciones $geoNear. Especifique todas las distancias en las mismas unidades que las del sistema de coordenadas de los documentos procesados:

Campo	Tipo	Descripción
distanceField	string	El campo de salida que contiene la distancia calculada. Para especificar un campo dentro de un documento incrustado, utiliza notación de puntos.
distanceMultiplier	Número	Opcional. Factor para multiplicar todas las distancias devueltas por la query. Por ejemplo, usar el distanceMultiplier para convertir radianes, tal como los devuelve una query esférica, a kilómetros multiplicando por el radio de la Tierra.
includeLocs	string	opcional. Esto especifica el campo de salida que identifica la ubicación utilizada para calcular la distancia. Esta opción es útil cuando un campo de ubicación contiene varias ubicaciones. Para especificar un campo dentro de un documento incrustado, usa la notación de puntos.
key		Opcional. Especificar el campo geoespacial indexado que se utilizará al calcular la distancia. Si tu colección tiene varios índices de 2d y/o varios de 2dsphere, debes usar la opción key para especificar la ruta de campo indexado que se utilizará. Especificar Qué Índice Geoespacial Usar proporciona un ejemplo completo. Si hay más de un índice 2d o más de un índice 2dsphere y no se especifica un key, MongoDB devolverá un error. Si no especificas el key, y tienes como máximo solo un índice 2d y/o solo un índice 2dsphere, MongoDB primero buscará un índice 2d para usar. Si un índice 2d no existe, MongoDB busca un índice 2dsphere para usar.
maxDistance	Número	opcional. La distancia máxima desde el punto central a la que los documentos pueden estar. MongoDB limita los resultados a aquellos documentos que se encuentren dentro de la distancia especificada desde el punto central. Especifica la distancia en metros si el punto especificado es GeoJSON y en radianes si el punto especificado es legacy coordinate pairs.
minDistance	Número	opcional. La distancia mínima desde el punto central que los documentos pueden estar. MongoDB limita los resultados a aquellos documentos que se encuentran fuera de la distancia especificada desde el punto central. Especifica la distancia en metros para los datos GeoJSON y en radianes para los legacy coordinate pairs. Novedad en la versión 3.2.
near	Punto GeoJSON o par de coordenadas antiguo	El punto para el que encontrar los documentos más cercanos. Si se utiliza un índice 2dsphere, se puede especificar el punto como un punto GeoJSON o como un par de coordenadas heredado. Si utiliza un índice 2d, especifique el punto como un par de coordenadas legacies.
query	Documento	opcional. Limita los resultados a los documentos que coinciden con la query. La sintaxis de queries es la sintaxis habitual de query para operaciones de lectura en MongoDB. No puedes especificar un predicado de $near en el campo query de la etapa $geoNear.
spherical	booleano	Opcional. Determina cómo MongoDB calcula la distancia entre dos puntos: Cuando true, MongoDB utiliza la semántica $nearSphere y calcula las distancias utilizando geometría esférica. Al false, MongoDB utiliza la $near semántica: geometría esférica para los índices 2dsphere e índices planares para los índices 2d. Por defecto: falso.

Comportamiento

Ejemplos

Cree una colección places con los siguientes documentos:

db.places.insertMany( [
   {
      name: "Central Park",
      location: { type: "Point", coordinates: [ -73.97, 40.77 ] },
      category: "Parks"
   },
   {
      name: "Sara D. Roosevelt Park",
      location: { type: "Point", coordinates: [ -73.9928, 40.7193 ] },
      category: "Parks"
   },
   {
      name: "Polo Grounds",
      location: { type: "Point", coordinates: [ -73.9375, 40.8303 ] },
      category: "Stadiums"
   }
] )

La siguiente operación crea un índice 2dsphere en el campo location:

db.places.createIndex( { location: "2dsphere" } )

db.places.aggregate([
   {
     $geoNear: {
        near: { type: "Point", coordinates: [ -73.99279 , 40.719296 ] },
        distanceField: "dist.calculated",
        maxDistance: 2,
        query: { category: "Parks" },
        includeLocs: "dist.location",
        spherical: true
     }
   }
])

{
   "_id" : 8,
   "name" : "Sara D. Roosevelt Park",
   "category" : "Parks",
   "location" : {
      "type" : "Point",
      "coordinates" : [ -73.9928, 40.7193 ]
   },
   "dist" : {
      "calculated" : 0.9539931676365992,
      "location" : {
         "type" : "Point",
         "coordinates" : [ -73.9928, 40.7193 ]
      }
   }
}

db.places.aggregate([
   {
     $geoNear: {
        near: { type: "Point", coordinates: [ -73.99279 , 40.719296 ] },
        distanceField: "dist.calculated",
        minDistance: 2,
        query: { category: "Parks" },
        includeLocs: "dist.location",
        spherical: true
     }
   }
])

{
   "_id" : 3,
   "name" : "Polo Grounds",
   "location": {
      "type" : "Point",
      "coordinates" : [ -73.9375, 40.8303 ]
   },
   "legacy" : [ -73.9375, 40.8303 ],
   "category" : "Stadiums"
}

db.places.aggregate([
   {
     $geoNear: {
        near: { type: "Point", coordinates: [ -73.98142 , 40.71782 ] },
        key: "location",
        distanceField: "dist.calculated",
        query: { "category": "Parks" }
     }
   },
   { $limit: 5 }
])

{
   "_id" : 8,
   "name" : "Sara D. Roosevelt Park",
   "location" : {
      "type" : "Point",
      "coordinates" : [
         -73.9928,
         40.7193
      ]
   },
   "category" : "Parks",
   "dist" : {
      "calculated" : 974.175764916902
   }
}
{
   "_id" : 1,
   "name" : "Central Park",
   "location" : {
      "type" : "Point",
      "coordinates" : [
         -73.97,
         40.77
      ]
   },
   "legacy" : [
      -73.97,
      40.77
   ],
   "category" : "Parks",
   "dist" : {
      "calculated" : 5887.92792958097
   }
}