To remove a document based on its ID, you need to ensure that you pass the ID as a MongoID object rather than just a string:
<?php
$id = '4b3f272c8ead0eb19d000000';
// will not work:
$collection->remove(array('_id' => $id), true);
// will work:
$collection->remove(array('_id' => new MongoId($id)), true);
?>
MongoCollection::remove
(PECL mongo >=0.9.0)
MongoCollection::remove — Supprime un enregistrement d'une collection
Description
public MongoCollection::remove
([ array
$criteria = array()
[, array $options = array()
]] ) : bool|arrayListe de paramètres
-
criteria -
Critères de requête pour le document à supprimer.
-
options -
Un tableau d'options pour l'opération de suppression. Les options actuellement disponibles sont :
"w"Voir les préoccupatios d'écriture. La valeur par défaut pour MongoClient est
1.-
"justOne"Spécifier
TRUEpour limiter la suppression à un seul document. SiFALSEest fourni, ou omis, alors tous les documents correspondants aux critères seront supprimés. "fsync"Booléen, par défaut à
FALSE. Si l'historisation est activée, il fonctionne exactement comme"j". Si l'historisation n'est pas activée, l'opération en écriture sera bloquante tant qu'elle ne sera pas synchronisé sur les fichiers de base de données du disque. Si vautTRUE, une insertion reconnue devient implicite, et cette option va écraser la configuration"w"à0.Note: Si l'historisation est activée, les utilisateurs sont vivement encouragés à utiliser l'option
"j"au lieu de"fsync". N'utilisez pas"fsync"et"j"en même temps, ou une erreur sera produite."j"Booléen, par défaut à
FALSE. Force les opérations en écriture a être bloquantes tant qu'elles ne sont pas synchronisées dans le journal du disque. Si vautTRUE, une écriture reconnue est implicite, et cette option va écraser la configuration"w"à0.Note: Si cette option est utilisée, et que l'historisation est désactivée, MongoDB 2.6+ va lancer une erreur, et l'écriture échouera ; les anciennes versions du serveur vont simplement ignorer cette ooption.
"socketTimeoutMS"Cette option spécifie la durée limite, en millisecondes, pour la communication avec un socket. Si le serveur ne répond pas pendant cette période, une exception MongoCursorTimeoutException sera émise et il n'y a aucune façon de déterminer si le serveur gère actuellement l'écriture ou non. Une valeur de
-1peut être spécifiée pour bloquer indéfiniement. La valeur par défaut pour MongoClient est30000(30 secondes)."w"Voir les préoccupatios d'écriture. La valeur par défaut pour MongoClient est
1."wTimeoutMS"Cette option spécifie la durée limite, en millisecondes, pour la reconnaissance des préoccupations d'écriture.Ceci n'est applicable que lorsque
"w"est supérieur à1, sachant que le délai d'attente maximal est en relation avec la réplication. Si la préoccupation d'écriture n'est pas spécifiée dans la durée limite, une exception MongoCursorException sera émise. Une valeur de0peut être spécifiée pour un blocage permanent. La valeur par défaut pour MongoClient est10000(dix secondes).
Les options suivantes sont obsolètes et ne devraient plus être utilisées :
"safe"Deprecated. Please use the write concern
"w"option."timeout"Alias obsolète pour
"socketTimeoutMS"."wtimeout"Alias obsolète pour
"wTimeoutMS".
Valeurs de retour
Retourne un tableau contenant le statut de l'effacement si l'option
"w" est définie. Sinon, retourne TRUE.
Les champs de ce tableau sont décrits dans la documentation de la méthode MongoCollection::insert().
Erreurs / Exceptions
Lance une exception MongoCursorException si l'option "w" est définie, et que l'écriture échoue.
Lance une exception MongoCursorTimeoutException si l'option "w" est définie à une valeur supérieure à 1 et que l'opération prend plus de temps que MongoCursor::$timeout millisecondes à se terminer. Ceci ne va pas mettre fin à l'opération sur le serveur, ce n'est qu'un délai d'attente maximal côté client. L'unité pour MongoCollection::$wtimeout est la milliseconde.
Historique
| Version | Description |
|---|---|
| 1.5.0 |
Ajout de l'option
Ajout de l'option
Emets une alerte de niveau |
| 1.3.4 | Ajout de l'option "wtimeout". |
| 1.3.0 |
Ajout de l'option
Le paramètre |
| 1.2.11 |
Lance une alerte de niveau E_DEPRECATED lorsque
le paramètre options est de type scalar.
|
| 1.2.0 |
Ajout de l'option "timeout".
|
| 1.0.11 |
Se déconnecte lors d'erreurs "not master" si "safe"
est utilisé.
|
| 1.0.9 |
Ajout de la capacité de passer des entiers à l'option
Ajout de l'option
Le type retourné a été modifié en un tableau contenant les informations
de l'erreur si l'option |
| 1.0.5 |
Modification du second paramètre en un tableau d'options.
Pre-1.0.5, le second paramètre était un booléen indiquant
l'option "safe".
|
Exemples
Exemple #1 Exemple avec MongoCollection::remove() et justOne
<?php
$radioactive = $db->radioactive;
// compte la quantité de plutonium
$remaining = $radioactive->count(array('type' => 94));
$halflife = $remaining/2;
// Suppression de la moitié
while ($halflife > 0) {
$radioactive->remove(array('type' => 94), array("justOne" => true));
$halflife--;
}
?>
Voir aussi
- MongoCollection::insert() - Insère un document dans la collection
- MongoCollection::update() - Modifie les enregistrements
- Documentation de MongoDB » concernant remove.
add a note
User Contributed Notes 2 notes
David Winter ¶
14 years ago
konstantin718 at gmail dot com ¶
11 years ago
If you try to remove a document that doesn't exist, remove() won't throw an exception.
Even if 'w' is set to 1, remove() will return an array similar to this:
Array ( [n] => 0 [connectionId] => 10726 [err] => [ok] => 1 )
So, in order to see if a remove() was really successful, you need to look at [n] key. If it's 0, that means the remove() did not remove any documents.
If remove() is successful, [n] will be > 0.
