MongoDB\Driver\WriteResult::getMatchedCount

(mongodb >=1.0.0)

MongoDB\Driver\WriteResult::getMatchedCount — Renvoie le nombre de documents sélectionnés pour la mise à jour

Description

final public function MongoDB\Driver\WriteResult::getMatchedCount(): int

Si l'opération de mise à jour n'entraîne aucune modification du document (par exemple, en définissant la valeur d'un champ sur sa valeur actuelle), le nombre correspondant peut être supérieur à la valeur retournée par MongoDB\Driver\WriteResult::getModifiedCount().

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne le nombre de documents sélectionnés pour la mise à jour.

Erreurs / Exceptions

Lève une exception MongoDB\Driver\Exception\LogicException si l'écriture n’a pas été reconnue.
Lance une exception MongoDB\Driver\Exception\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.

Historique

Version	Description
PECL mongodb 2.0.0	Cette méthode déclenche désormais une exception lorsqu'elle est appelée pour une écriture non reconnue, au lieu de retourner `null`.

Exemples

Exemple #1 Exemple avec MongoDB\Driver\WriteResult::getMatchedCount()

<?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->getMatchedCount());

?>

Résultat de l'exemple ci-dessus est similaire à :

int(1)

Voir aussi

MongoDB\Driver\WriteResult::getModifiedCount() - Renvoie le nombre de documents existants mis à jour
MongoDB\Driver\WriteResult::isAcknowledged() - Retourne si l'écriture a été reconnue

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.