MongoDB\Driver\WriteResult::getUpsertedIds
Returns an array of identifiers for upserted documents
Description
final public array MongoDB\Driver\WriteResult::getUpsertedIds()
Parameters
This function has no parameters.
Return Values
Returns an array of identifiers (i.e. "_id"
field values)
for upserted documents. The array keys will correspond to the index of the
write operation (from MongoDB\Driver\BulkWrite)
responsible for the upsert.
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
Examples
Example #1 MongoDB\Driver\WriteResult::getUpsertedIds example
<?php
$manager = new MongoDB\Driver\Manager;
$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1]);
$bulk->update(['x' => 1], ['$set' => ['y' => 3]]);
$bulk->update(['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]);
$bulk->update(['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]);
$bulk->delete(['x' => 1]);
$result = $manager->executeBulkWrite('db.collection', $bulk);
var_dump($result->getUpsertedIds());
?>
The above example will output
something similar to:
array(2) {
[2]=>
object(MongoDB\BSON\ObjectId)#4 (1) {
["oid"]=>
string(24) "580e62a224f2302f191b880b"
}
[3]=>
object(MongoDB\BSON\ObjectId)#5 (1) {
["oid"]=>
string(24) "580e62a224f2302f191b880c"
}
}
See Also
- MongoDB\Driver\WriteResult::getUpsertedCount
- MongoDB\Driver\WriteResult::isAcknowledged