cursor.showRecordId()

項目一覧

定義

互換性
例

定義

cursor.showRecordId()

重要

mongosh メソッド

このページでは、 mongosh メソッドが文書化されます。これは Node.js などの言語固有のドライバーのドキュメントではありません。

MongoDB API ドライバーについては、各言語の MongoDB ドライバードキュメントを参照してください。

クエリによって返されたドキュメントに$recordIdフィールドを追加します。 $recordIdは、コレクション内のドキュメントを一意に識別する内部キーです。 $recordId形式:

'$recordId': Long(<int>)

次の値を返します。	ドキュメントフィールドと追加の`$recordId`フィールドを含む変更済みカーソルオブジェクト。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージドサービスです

注意

このコマンドは、すべての MongoDB Atlas クラスターでサポートされています。すべてのコマンドに対する Atlas のサポートについては、「サポートされていないコマンド」を参照してください。

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 }
] )

次のfind()の例では、 showRecordId()を使用して、出力のpizzaドキュメントフィールドに$recordIdを追加します。

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

戻る

cursor.returnKey

cursor.size