PHP 7.4.0 alpha 2 Released

MongoDB\Driver\WriteResult::getInsertedCount

(mongodb >=1.0.0)

MongoDB\Driver\WriteResult::getInsertedCountReturns the number of documents inserted (excluding upserts)

Description

final public MongoDB\Driver\WriteResult::getInsertedCount ( void ) : integer|null

Parameters

This function has no parameters.

Return Values

Returns the number of documents inserted (excluding upserts), or NULL if the write was not acknowledged.

Errors/Exceptions

Examples

Example #1 MongoDB\Driver\WriteResult::getInsertedCount() 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->getInsertedCount());

?>

The above example will output:

int(1)

See Also

add a note add a note

User Contributed Notes 1 note

up
-1
noam
6 months ago
In case you are trying to add an index to a collection, and the index is already there, the value of getInsertedCount() depends on the MongoDB server version.
For example, MongoDB version 2.4 consider the index as inserted, but version 3.6 does not.
To Top