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|array

Liste 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 TRUE pour limiter la suppression à un seul document. Si FALSE est 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 vaut TRUE, 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 vaut TRUE, 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 -1 peut être spécifiée pour bloquer indéfiniement. La valeur par défaut pour MongoClient est 30000 (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 de 0 peut être spécifiée pour un blocage permanent. La valeur par défaut pour MongoClient est 10000 (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 "wTimeoutMS", qui remplace l'option "wtimeout". Emets une alerte de niveau E_DEPRECATED lorsque "wtimeout" est utilisée.

Ajout de l'option "socketTimeoutMS", qui remplace l'option "timeout". Emets une alerte de niveau E_DEPRECATED lorsque "timeout" est utilisée.

Emets une alerte de niveau E_DEPRECATED lorsque "safe" est utilisée.

1.3.4 Ajout de l'option "wtimeout".
1.3.0

Ajout de l'option "w".

Le paramètre options n'accepte plus de booléen pour indiquer "justOne". A la place, utilisez la syntaxe 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