cursor.showRecordId() (original) (raw)

cursor.showRecordId()

Important

mongosh Method

This page documents a mongosh method. This is _not_the documentation for a language-specific driver, such as Node.js.

For MongoDB API drivers, refer to the language-specificMongoDB driver documentation.

Appends the $recordId field to documents returned by a query.$recordId is the internal key that uniquely identifies a document in a collection. $recordId format:

This method is available in deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Note

This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, seeUnsupported Commands.

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

The example uses this pizzas collection:

db.pizzas.insertMany( [

   { type: "pepperoni", size: "small", price: 4 },

   { type: "cheese", size: "medium", price: 7 },

   { type: "vegan", size: "large", price: 8 }

] )

The following find() example usesshowRecordId() to append the $recordId to thepizza document fields in the output:

db.pizzas.find().showRecordId()

Example output:

[

   {

      _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")

   }

]