cursor.showRecordId() (método mongosh)

Definición

cursor.showRecordId()

Importante

Método mongosh

Esta página documenta un método mongosh. No se trata de la documentación de un controlador específico de un lenguaje, como Node.js.

Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.

Adjunta el campo $recordId a los documentos devueltos por una query. $recordId es la clave interna que identifica de manera única un documento en una colección. $recordId formato:

'$recordId': Long(<int>)

Devuelve:	Un objeto cursor modificado que contiene los campos del documento y el campo agregado $recordId.

Compatibilidad

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

• MongoDB Atlas: El servicio totalmente administrado 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.

Ejemplo

El ejemplo utiliza esta colección pizzas:

db.pizzas.insertMany( [
   { type: "pepperoni", size: "small", price: 4 },
   { type: "cheese", size: "medium", price: 7 },
   { type: "vegan", size: "large", price: 8 }
] )

El siguiente ejemplo find() utiliza showRecordId() para agregar $recordId a los campos del documento pizza en la salida:

db.pizzas.find().showRecordId()

Ejemplo de salida:

[
   {
      _id: ObjectId("62ffc70660b33b68e8f30435"),
      type: 'pepperoni',
      size: 'small',
      price: 4,
      '$recordId': Long("1")
   },
   {
      _id: ObjectId("62ffc70660b33b68e8f30436"),
      type: 'cheese',
      size: 'medium',
      price: 7,
      '$recordId': Long("2")
   },
   {
      _id: ObjectId("62ffc70660b33b68e8f30437"),
      type: 'vegan',
      size: 'large',
      price: 8,
      '$recordId': Long("3")
   }
]