php8.5
Home/ Manual/ driver / writeresult/ MongoDB\Driver\WriteResult::getInsertedCount

MongoDB\Driver\WriteResult::getInsertedCount

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Returns the number of documents inserted (excluding upserts)

Description

MongoDB\Driver\WriteResult::getInsertedCount(): int

Parameters Parameters

Return Values

Returns the number of documents inserted (excluding upserts).

Errors/Exceptions

Changelog

VersionDescription

Examples

MongoDB\Driver\WriteResult::getInsertedCount() example

php
<?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:

output
int(1)

See Also

  • MongoDB\Driver\WriteResult::isAcknowledged

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