Docs Menu
Docs Home
/ / /
PHP ライブラリ マニュアル
/ / /

MongoDB\UpdateResult::getUpsertedId()

項目一覧

  • 定義
  • Return Values
  • エラーと例外
  • その他の参照
MongoDB\UpdateResult::getUpsertedId()

ID( アップサートされたドキュメントの_idフィールド値)をスキャンします。

function getUpsertedId(): mixed|null

ID(つまり アップサートされたドキュメントの_idフィールド値)をスキャンします。 アップサートされたドキュメントがない場合は、 nullが返されます。

アップサートを行う前にドキュメントに ID が存在した場合(つまり、サーバーが ID を生成する必要がなかった場合)、その_idフィールド値がこれに含まれます。 サーバーが生成した ID は MongoDB\BSON\ObjectId になります インスタンス。

このメソッドが呼び出され、書込み操作で未確認の書込み保証が使用された場合はMongoDB\Exception\BadMethodCallException

戻る

getUpsertedCount()