Docs Menu

Docs HomeDevelop ApplicationsMongoDB Manual


On this page

  • Definition
  • Example


mongosh Method

This is a mongosh method. This is not the documentation for Node.js or other programming language specific driver methods.

In most cases, mongosh methods work the same way as the legacy mongo shell methods. However, some legacy methods are unavailable in mongosh.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

For MongoDB API drivers, refer to the language specific MongoDB 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:

'$recordId': Long(<int>)
Returns:A modified cursor object that contains the document fields and the appended $recordId field.

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 uses showRecordId() to append the $recordId to the pizza document fields in the output:


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")
← cursor.returnKey()

On this page