MongoCollection
PHP Manual

MongoCollection::remove

(PECL mongo >=0.9.0)

MongoCollection::removeRemove records from this collection

Descrierea

public bool|array MongoCollection::remove ([ array $criteria = array() [, array $options = 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ă:

    Această opțiune e învechită. Utilizați în loc opțiunea "j".

  • "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.

  • "socketTimeoutMS"

    Integer, defaults to MongoCursor::$timeout. If acknowledged writes are used, this sets how long (in milliseconds) for the client to wait for a database response. If the database does not respond within the timeout period, a MongoCursorTimeoutException will be thrown.

  • "w"

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

  • "wTimeoutMS"

    How long to wait for write concern acknowledgement. The default value for MongoClient is 10000 milliseconds.

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

  • "safe"

    Dezaprobat. Utilizați opțiunea WriteConcern w.

  • "timeout"

    O valoare de tip întreg, implicit este MongoCursor::$timeout. Dacă se utilizează înscrieri cu confirmare, acest parametru stabilește intervalul de timp maximal (în milisecunde) pentru ca clientul să primească răspuns de la baza de date. Dacă baza de date nu răspunde în intervalul de timeout, o excepție MongoCursorTimeoutException va fi emisă.

  • "wtimeout"

    Cât timp să se aștepte confirmarea WriteConcern. Valoarea implicită pentru MongoClient este 10000 milisecunde.

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.

Istoria schimbărilor

Versiunea Descriere
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.

1.3.4 Added "wtimeout" option.
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).

1.2.11 Emits E_DEPRECATED when options is scalar.
1.2.0 Added "timeout" option.
1.0.11 Disconnects on "not master" errors if "safe" is set.
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.

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

?>

Vedeți de asemenea


MongoCollection
PHP Manual