MongoCollection
PHP Manual

MongoCollection::remove

(PECL mongo >=0.9.0)

MongoCollection::removeSupprime un enregistrement d'une collection

Description

public mixed MongoCollection::remove ( array $criteria [, 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 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.

Valeurs de retour

Si l'option "safe" est définie, retourne un tableau associatif contenant le statut de l'effacement ("ok"), le nombre d'éléments effacés ("n"), mais aussi toutes les erreurs rencontrées ("err"). Sinon, retourne TRUE si l'effacement a été correctement émise, FALSE sinon.

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 à une valeur supérieure à 1 et la base de données ne peut répliquer l'opération dans un délai de MongoCollection::$wtimeout millisecondes.

Historique

Version Description
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.5 Modification du second paramètre en un tableau d'options. Avant la version 1.0.5, le second paramètre était un booléen indiquant l'option "justOne" et il n'y avait pas d'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

Documentation de MongoDB » concernant remove.


MongoCollection
PHP Manual