Docs Menu
Docs Home
/ / /
PHP Library Manual
/ / /

MongoDB\UpdateResult::getUpsertedCount()

On this page

  • Definition
  • Return Values
  • Errors/Exceptions
  • See Also
MongoDB\UpdateResult::getUpsertedCount()

Return the number of documents that were upserted.

function getUpsertedCount(): integer

This method should only be called if the write was acknowledged.

The total number of documents that were upserted. This should be either 0 or 1 for an acknowledged update or replace operation, depending on whether an upsert occurred.

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

Back

getModifiedCount()

Next

getUpsertedId()