MongoDB\UpdateResult::getUpsertedCount()

Definition

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.

Return Values

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.

Errors/Exceptions

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

See Also

• MongoDB\Driver\WriteResult::getUpsertedCount()