cursor.returnKey()

Definición

cursor.returnKey()

Importante

Método mongosh

Este es un método mongosh. Esta no es la documentación de Node.js ni de otros métodos de controladores específicos de lenguajes de programación.

En la mayoría de los casos, los métodos mongosh funcionan de la misma manera que los métodos tradicionales mongo métodos shell. Sin embargo, algunos métodos heredados no están disponibles en mongosh.

Para la documentación heredada de mongo shell, revisa la documentación de la versión correspondiente de MongoDB Server:

• mongo shell v4.4

• mongo shell v4.2

• mongo shell v4.0

Para los controladores de la API de MongoDB, consultar la documentación específica del controlador de MongoDB para cada lenguaje.

Tip

$meta soporta la palabra clave "indexKey" para devolver los metadatos de la clave del índice si se usa un índice. Se prefiere el uso de { $meta: "indexKey" } sobre cursor.returnKey().

Modifica el cursor para devolver las claves del índice en lugar de los documentos.

El cursor.returnKey() tiene el siguiente formulario:

cursor.returnKey()

Devuelve:	El cursor al que returnKey() está unido con un conjunto de resultados modificado. Esto permite que se encadenen modificadores adicionales de cursor.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Comportamiento

Si la query no utiliza un índice para realizar la operación de lectura, el cursor devuelve documentos vacíos.

Ejemplo

La colección restaurants contiene documentos con el siguiente esquema:

{
   "_id" : ObjectId("564f3a35b385149fc7e3fab9"),
   "address" : {
      "building" : "2780",
      "coord" : [
         -73.98241999999999,
         40.579505
      ],
      "street" : "Stillwell Avenue",
      "zipcode" : "11224"
   },
   "borough" : "Brooklyn",
   "cuisine" : "American ",
   "grades" : [
      {
         "date" : ISODate("2014-06-10T00:00:00Z"),
         "grade" : "A",
         "score" : 5
      },
      {
         "date" : ISODate("2013-06-05T00:00:00Z"),
         "grade" : "A",
         "score" : 7
      }
   ],
   "name" : "Riviera Caterer",
   "restaurant_id" : "40356018"
}

La colección tiene dos índices además del índice _id por defecto:

{
   "v" : 1,
   "key" : {
      "_id" : 1
   },
   "name" : "_id_",
   "ns" : "guidebook.restaurant"
},
{
   "v" : 1,
   "key" : {
      "cuisine" : 1
   },
   "name" : "cuisine_1",
   "ns" : "guidebook.restaurant"
},
{
   "v" : 1,
   "key" : {
      "_fts" : "text",
      "_ftsx" : 1
   },
   "name" : "name_text",
   "ns" : "guidebook.restaurant",
   "weights" : {
      "name" : 1
   },
   "default_language" : "english",
   "language_override" : "language",
   "textIndexVersion" : 3
}

El siguiente código utiliza el método cursor.returnKey() para devolver únicamente los campos indexados utilizados para ejecutar la query:

var csr = db.restaurant.find( { "cuisine" : "Japanese" } )
csr.returnKey()

Esto devuelve lo siguiente:

{ "cuisine" : "Japanese" }
{ "cuisine" : "Japanese" }
{ "cuisine" : "Japanese" }
{ "cuisine" : "Japanese" }
...