Docs Menu

Docs HomeMongoDB Manual

cursor.showRecordId()

On this page

  • Definition
  • Example
cursor.showRecordId()

Important

mongo Shell Method

This page documents the mongo shell method, and does not refer to the MongoDB Node.js driver (or any other driver) method. For corresponding MongoDB driver API, refer to your specific MongoDB driver documentation instead.

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:

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")
}
]
←  cursor.returnKey()cursor.size() →

On this page

Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.