游标.showRecordId()（mongosh方法）

定义

cursor.showRecordId()

重要

mongosh 方法

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

如需了解 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。

将$recordId字段附加到查询返回的文档。 $recordId是唯一标识集合中文档的内部密钥。 $recordId格式：

'$recordId': Long(<int>)

返回：	修改后的游标对象，包含文档字段和附加的`$recordId`字段。

兼容性

此方法可用于以下环境中托管的部署：

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

注意

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

MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本
MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

例子

该示例使用此pizzas集合：

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()

示例输出：

[
   {
      _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")
   }
]