Docs Menu

Docs HomePHP Library Manual


On this page

  • Definition
  • Return Values
  • Errors/Exceptions
  • See Also

Return the ID (i.e. _id field value) of the upserted document.

function getUpsertedId(): mixed|null

The ID (i.e. _id field value) of the upserted document. If no document was upserted, null will be returned.

If the document had an ID prior to upserting (i.e. the server did not need to generate an ID), this will contain its _id field value. Any server-generated ID will be a MongoDB\BSON\ObjectId instance.

MongoDB\Exception\BadMethodCallException if this method is called and the write operation used an unacknowledged write concern.

←  MongoDB\UpdateResult::getUpsertedCount()MongoDB\UpdateResult::isAcknowledged() →