MongoCollection::remove - Remove records from this collection
Вернуться к: MongoCollection
MongoCollection::remove
(PECL mongo >=0.9.0)
MongoCollection::remove — Remove records from this collection
Описание
$criteria
= array()
[, array $options
= array()
]] )Список параметров
-
criteria
-
Query criteria for the documents to delete.
-
options
-
An array of options for the remove operation. Currently available options include:
"w"
Смотрите Контроль записи. Значение по умолчанию для MongoClient является 1.
-
"justOne"
Specify
TRUE
to limit deletion to just one document. IfFALSE
or omitted, all documents matching the criteria will be deleted. "fsync"
Булево, по умолчанию
FALSE
. Если включено журналирование, то работает также как и "j". Если журналирование не включено, то операции записи блокируются пока не будут синхронизированы с файлами на жестком диске. ЕслиTRUE
, то применяется подтвержденная вставка и эта опция переопределяет опцию "w" в значение 0.Замечание: Если журналирование включено, то пользователю настоятельно рекомендуется использовать опцию "j" вместо "fsync". Не используйте "fsync" и "j" одновременно,так как это может привести к ошибке.
"j"
Булево, по умолчанию
FALSE
. Блокирует операции записи пока они не будут синхронизированы с журналом на диске. ЕслиTRUE
, то применяется подтвержденная вставка и эта опция переопределяет опцию "w" в значение 0.Замечание: Если применяется эта опция и журналирование отключено, то MongoDB 2.6+ выбросит ошибку и прервет запись; старые версии сервера просто игнорируют эту опцию.
"socketTimeoutMS"
Эта опция определяет время в миллисекундах для общения в socket. Если сервер не ответил за отведенное время, то будет брошено исключение MongoCursorTimeoutException, и не будет никакой возможности определить произвел ли сервер запись или нет. Значение -1 используется для постоянно отключения этой функции. Значением по умолчанию для MongoClient является 30000 (30 секунд).
"w"
Смотрите Контроль записи. Значение по умолчанию для MongoClient является 1.
"wTimeoutMS"
Эта опция определяет лимит времени в миллисекундах для подтверждения контроля записи. Она применима только, если "w" больше 1, так как ограничение времени относится к репликации. Если контроль записи не подтвержден за отведенное время, то будет выброшено исключение MongoCursorException. Значение 0 для постоянного отключения. Значением по умолчанию для MongoClient является 10000 (десять секунд).
The following options are deprecated and should no longer be used:
"safe"
Устаревшая опция. Используйте опцию "w" контроля записи.
"timeout"
Устаревший псевдоним для "socketTimeoutMS".
"wtimeout"
Устаревший псевдоним для "wTimeoutMS".
Возвращаемые значения
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().
Ошибки
Исключение MongoCursorException бросается, если установлена опция "w" и не прошла запись.
Исключение MongoCursorTimeoutException бросается, если опция "w" установлена в значение больше одного и операция заняла больше, чем MongoCursor::$timeout миллисекунд. При этом операция на сервере не прерывается, так как это ограничение времени работает на клиентской стороне. Операция в миллисекундах в MongoCollection::$wtimeout.
Список изменений
Версия | Описание |
---|---|
1.5.0 |
Added "wTimeoutMS" option, which replaces
"wtimeout". Emits
Added "socketTimeoutMS" option, which replaces
"timeout". Emits
Emits |
1.3.4 | Added "wtimeout" option. |
1.3.0 |
Added "w" option.
The |
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. |
Примеры
Пример #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--;
}
?>
Смотрите также
- MongoCollection::insert() - Inserts a document into the collection
- MongoCollection::update() - Update records based on a given criteria
- MongoDB core docs on » remove.
Вернуться к: MongoCollection