MongoCollection::remove
(PECL mongo >=0.9.0)
MongoCollection::remove — Supprime un enregistrement d'une collection
Description
$criteria = array()
[, array $options = array()
]] )Liste de paramètres
-
criteria -
La description des enregistrements à supprimer.
-
options -
Options pour l'effacement.
"w"
Voir WriteConcerns. La valeur par défaut pour MongoClient est 1.
-
"justOne"
Efface un seul enregistrement correspondant aux critères.
"fsync"
Booléen, par défaut vaut
FALSE. Force la synchronisation de l'insertion avant de retourner le succès de l'opération. Si vautTRUE, une insertion reconnue est implicite, et écrasera la configuration de w à 0."j"
Booléen, par défaut
FALSE. Force l'insertion à être synchronisée avec le journal avant de retourner le succès de l'opération. Si vautTRUE, la reconnaissance d'une insertion sera appliquée, et va écraser la configuration passant de w à 0."w"
Voir WriteConcerns. La valeur par défaut pour MongoClient est 1.
"wtimeout"
Durée d'attente pour la reconnaissance WriteConcern. La valeur par défaut pour MongoClient est 10000 millisecondes.
"safe"
Obsolète. Veuillez utiliser l'option w de WriteConcern w.
"timeout"
Entier, par défaut, vaut MongoCursor::$timeout. Si la reconnaissance des écritures est utilisée, ceci va définir (en millisecondes) la durée d'attente du client d'une réponse de la base de données. Si la base de données ne répond pas durant cette période, une exception de type MongoCursorTimeoutException sera émise.
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 à un, et que l'opération prend plus de temps que MongoCursor::$timeout millisecondes à se terminer. Ceci ne tue pas l'opération sur le serveur, c'est un délai d'attente maximal côté client. La mesure pour MongoCollection::$wtimeout est le milliseconde.
Historique
| Version | Description |
|---|---|
| 1.3.0 |
Le paramètre options
n'accepte plus de booléen pour indiquer "justOne".
A la place, ceci doit être indiqué via
array('justOne' => true).
|
| 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 "safe" (n'acceptaient que des booléens avant). Ajout de l'option "fsync". Le type retourné a été modifié en un tableau contenant les informations de l'erreur si l'option "safe" est utilisée, sinon, ce sera un booléen comme auparavant. |
| 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.
