php8.5
Home/ Manual/ driver / bulkwritecommandresult/ MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount

MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount

PHP function Edit on GitHub ✎

(mongodb >=2.1.0)

Returns the number of documents upserted

Description

MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount(): int

Parameters Parameters

Return Values

Returns the total number of documents upserted by all operations.

Errors/Exceptions

Examples

MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount() example

php
<?php

$manager = new MongoDB\Driver\Manager;

$bulk = new MongoDB\Driver\BulkWriteCommand;
$bulk->insertOne('db.coll', ['x' => 1]);
$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]);
$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]);
$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]);
$bulk->deleteMany('db.coll', []);

$result = $manager->executeBulkWriteCommand($bulk);

var_dump($result->getUpsertedCount());

?>

The above example will output:

output
int(2)

See Also

  • MongoDB\Driver\BulkWriteCommandResult::getUpdateResults
  • MongoDB\Driver\BulkWriteCommandResult::isAcknowledged

Source: reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml · from the official PHP manual (php/doc-en)