Edit Report a Bug

MongoCollection::remove

(PECL mongo >=0.9.0)

MongoCollection::remove — Remove records from this collection

Descrierea

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

Parametri

criteria

Query criteria for the documents to delete.

options

An array of options for the remove operation. Currently available options include:

"w"
Vedeți WriteConcerns. Valoarea implicită pentru MongoClient este 1.
"justOne"

Specify true to limit deletion to just one document. If false or omitted, all documents matching the criteria will be deleted.
"fsync"
O valoare boolean-ă, valoarea implicită este false. Dacă jurnalizarea e activată, ea funcționează exact ca "j". Dacă jurnalizarea nu este acticvată, atunci se forțează sincronizarea pe disc a operațiunii de inserare înainte de a întoarce succes. Dacă are valoarea true, se presupune efectuarea unei inserări cu confirmare și setarea w va fi modificată în 0.

Notă: Dacă jurnalizarea este activată, utilizatorii sunt încurajați să utilizeze opțiunea "j" în loc de "fsync". Nu utilizați "fsync" și "j" simultan, deoarece aceasta va rezulta în eroare.
"j"
O valoare boolean-ă, cu valoarea implicită false. Forțează sincronizarea cu jurnalul a operațiunii de inserare, înainte de a întoarce succes. Dacă are valoarea true, se presupune efectuarea unei inserări cu confirmare și setarea w va fi modificată în 0.

Notă: Dacă această opțiune e utilizată, iar jurnalizarea e dezactivată, MongoDB 2.6+ va emite o eroare și înscrierea va eșua; versiunile mai vechi ale serverului pur și simplu vor ignora opțiunea.
"socketTimeoutMS"
Această opțiune specifică limita de timp în milisecunde pentru comunicarea prin socket. Dacă serverul nu răspunde în limita intervalului de timp, se va emite o MongoCursorTimeoutException și nu va fi nici o posibilitate de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea -1 poate fi specificată pentru a suspenda pentru o perioadă nedefinită. Valoarea implicită pentru MongoClient este 30000 (30 secunde).
"w"
Vedeți WriteConcerns. Valoarea implicită pentru MongoClient este 1.
"wTimeoutMS"
Această opțiune specifică limita de timp în milisecunde pentru confirmarea write concern. Aceasta este aplicabilă doar atunci când "w" este mai mare decât 1, deoarece expirarea timpului ține de replicare. Dacă "write concern" nu este satisfăcută în limita intervalului de timp, se va emite o MongoCursorException. Valoarea 0 poate fi specificată pentru a suspenda pentru o perioadă nedefinită. Valoarea implicită pentru MongoClient este 10000 (zece secunde).

The following options are deprecated and should no longer be used:

"safe"
Învechită. Utilizați opțiunea WriteConcern w.
"timeout"
Un pseudonim învechit pentru "socketTimeoutMS".
"wtimeout"
Un pseudonim învechit pentru "wTimeoutMS".

Valorile întoarse

Returns an array containing the status of the removal if the "w" option is set. Otherwise, returns true.

Fields in the status array are described in the documentation for MongoCollection::insert().

Erori/Excepții

Generează o excepție MongoCursorException dacă opțiunea "w" este stabilită și înscrierea eșuează.

Generează o excepție MongoCursorTimeoutException dacă opțiunea "w" este stabilită la o valoare mai mare decât unu și operațiunea durează mai mult de MongoCursor::$timeout milisecunde. Aceasta nu va întrerupe operațiunea pe server, este un timeout de partea clientului. Operațiunea din MongoCollection::$wtimeout este în milisecunde.

Istoricul schimbărilor

Versiune	Descriere
PECL mongo 1.5.0	Added `"wTimeoutMS"` option, which replaces `"wtimeout"`. Emits `E_DEPRECATED` when `"wtimeout"` is used. Added `"socketTimeoutMS"` option, which replaces `"timeout"`. Emits `E_DEPRECATED` when `"timeout"` is used. Emits `E_DEPRECATED` when `"safe"` is used.
PECL mongo 1.3.4	Added `"wtimeout"` option.
PECL mongo 1.3.0	Added `"w"` option. The `options` parameter no longer accepts a boolean to signify `"justOne"`. Instead, this now has to be done with `array('justOne' => true)`.
PECL mongo 1.2.11	Emits `E_DEPRECATED` when `options` is scalar.
PECL mongo 1.2.0	Added `"timeout"` option.
PECL mongo 1.0.11	Disconnects on "not master" errors if `"safe"` is set.
PECL mongo 1.0.9	Added ability to pass integers to the `"safe"` option, which previously only accepted booleans. Added `"fsync"` option. The return type was changed to be an array containing error information if the `"safe"` option is used. Otherwise, a boolean is returned as before.
PECL mongo 1.0.5	Changed second parameter to be an array of options. Pre-1.0.5, the second parameter was a boolean indicating the `"safe"` option.

Exemple

Example #1 MongoCollection::remove() with justOne example


<?php

$radioactive = $db->radioactive;

// count how much more plutonium there is
$remaining = $radioactive->count(array('type' => 94));

$halflife = $remaining/2;

// remove half of it
while ($halflife > 0) {
    $radioactive->remove(array('type' => 94), array("justOne" => true));
    $halflife--;
}

?>

A se vedea și

MongoCollection::insert() - Inserts a document into the collection
MongoCollection::update() - Update records based on a given criteria
MongoDB core docs on » remove.

add a note

User Contributed Notes 2 notes

down

David Winter ¶

14 years ago


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

down

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.

add a note