[edit] Last updated: Fri, 25 May 2012

MongoCollection::remove

(PECL mongo >=0.9.0)

MongoCollection::remove — Supprime un enregistrement d'une collection

Description

public bool|array MongoCollection::remove ([ array $criteria = array() [, array $options = array() ]] )

Liste de paramètres

criteria

La description des enregistrements à supprimer.

options

Options pour l'effacement.

"justOne"

Efface un seul enregistrement correspondant aux critères.
"safe"

Peut être un booléen ou un entier, et vaut par défaut FALSE. Si vaut FALSE, le programme continue l'exécution sans attendre la réponse de la base de données. Si vaut TRUE, le programme attendra la réponse de la base de données et lancera une exception MongoCursorException si l'insertion a échouée.

Si vous utilisez la réplication et que le maitre a changé, utiliser "safe" fera que le pilote se déconnectera du maitre, enverra une exception, et tentera de trouver un nouveau maitre à l'opération suivante (votre application doit décider si oui ou non l'opération devra être rééssayée sur le nouveau maitre).

Si vous n'utilisez pas "safe" avec une paire de réplication et que le maitre change, il n'y aura aucun moyen pour le pilote d'avoir connaissance de ce changement et il continuera des écritures en échec.

Si safe est un entier, l'insertion sera répliquée sur l'ensemble des machines avant de retourner le succès de l'opération (ou lancera une exception si la réplication échoue). Cette valeur écrase la variable w définie sur la collection.
"fsync"

Booléen et vaut par défaut FALSE. Force l'insertion à être synchronisée sur le disque avant de retourner le succès de l'opération. Si vaut TRUE, une insertion sécurisée sera effectuée et le paramétrage de safe sera automatiquement valorisé à FALSE.
"timeout"

Entier, par défaut, vaut MongoCursor::$timeout. Si "safe" est défini, il définira (en millisecondes) le temps d'attente du client d'une réponse de la base de données. Si la base de données ne répond pas dans la période de timeout, une exception MongoCursorTimeoutException sera émise.

Valeurs de retour

Si le paramètre safe est défini, retourne un tableau contenant le statut de l'effacement. Sinon, retourne un booléen représentant le fait que le tableau n'était pas vide (un tableau vide ne sera pas inséré). Ce champ de ce tableau est décrit dans la documentation de la méthode MongoCollection::insert().

Erreurs / Exceptions

Lance une exception MongoCursorException si l'option "safe" est définie et que l'effacement échoue.

Lance une exception MongoCursorTimeoutException si l'option "safe" est définie et que l'opération prend plus de temps que MongoCollection::$wtimeout millisecondes. Ceci ne tue pas le processus serveur, mais uniquement le délai d'attente côté client.

Historique

Version	Description
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 "justOne" et il n'y avait pas d'option "safe".
1.0.9	Ajout de la capacité de passer des entiers aux options "safe" (n'acceptaient que des booléens avant) et ajout de l'option "fsync".
1.0.9	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.11	Se déconnecte lors d'erreurs "not master" si "safe" est utilisé.
1.2.0	Ajout de l'option timeout.
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).

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 tableau dans la collection
MongoCollection::update() - Modifie les enregistrements
Documentation de MongoDB » concernant remove.

add a note User Contributed Notes MongoCollection::remove

David Winter 02-Jan-2010 05:55


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);

?>

add a note