(PECL mongo >=0.9.0)
MongoCollection::remove — Remove records from this collection
Description of records to remove.
Options for remove.
"justOne"
Remove at most one record matching this criteria.
"safe"
Can be a boolean or integer, defaults to FALSE. If FALSE, the program continues executing without waiting for a database response. If TRUE, the program will wait for the database response and throw a MongoCursorException if the update did not succeed.
If safe is an integer, will replicate the update to that many machines before returning success (or throw an exception if the replication times out, see wtimeout). This overrides the w variable set on the collection.
"fsync"
Boolean, defaults to FALSE. Forces the update to be synced to disk before returning success. If TRUE, a safe update is implied and will override setting safe to FALSE.
If "safe" is set, returns an associative array with the status of the remove ("ok"), the number of items removed ("n"), and any error that may have occured ("err"). Otherwise, returns TRUE if the remove was successfully sent, FALSE otherwise.
Throws MongoCursorException if the "safe" option is set and the remove fails.
Throws MongoCursorTimeoutException if the "safe" option is set to a value greater than one and the database cannot replicate the operation in MongoCollection::$wtimeout milliseconds.
| Version | Description |
|---|---|
| 1.0.5 | Changed second parameter to an array of options. Pre-1.0.5, the second parameter was a boolean indicating the "justOne" option and there was no safe option. |
| 1.0.9 | Added ability to pass integers to "safe" options (only accepted booleans before) and added "fsync" option. |
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) {
$uranium->remove(array('type' => 94), array("justOne" => true));
$halflife--;
}
?>
MongoDB core docs on » remove.