MongoCollection
PHP Manual

MongoCollection::remove

(PECL mongo >=0.9.0)

MongoCollection::removeRemove records from this collection

Описание

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

Список параметров

criteria

Description of records to remove.

options

Options for remove.

  • "w"

    Смотрите WriteConcerns. Значение по умолчанию для MongoClient является 1.

  • "justOne"

    Remove at most one record matching this criteria.

  • "fsync"

    Булевое значение, по умолчанию равно FALSE. Если журналлирование включено, работает точно так же как и "j". Если же журналирование не включено, то вынуждает выполнить синхронизацию вставленных данных на диск перед возвращением успешного статуса. Если установлено в TRUE, то будет использована синхронизированная вставка данных, и опция w будет установлена в 0.

    Замечание:

    Данная опция устарела. Используйте вместо нее опцию "j".

  • "j"

    Булевое значение, по умолчанию FALSE. Форсирует синхронизацию вставки записи с журналом перед возвращением успешного статуса. Если установлено в TRUE, то будет неявно применена подтвержденная вставка и перезаписана установка опции w в 0.

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

    "socketTimeoutMS"

  • "w"

    Смотрите WriteConcerns. Значение по умолчанию для MongoClient является 1.

  • "wtimeout"

    Время ожидания подтверждения WriteConcern. По умолчанию составляет 10000 миллисекунд для класса MongoClient

  • "wTimeoutMS"

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

  • "safe"

    Устарело. Пожалуйста, используйте WriteConcern опцию w.

  • "timeout"

    Целое значение, по умолчанию равно MongoCursor::$timeout. Если используются подтвержденные операции записи, то значение обозначает количество миллисекунд, в течение которого клиент будет ожидать ответа от базы данных. Если база данных не ответит в течение указанного периода, то будет брошено исключение MongoCursorTimeoutException.

Возвращаемые значения

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 Renamed the "wtimeout" option to "wTimeoutMS".
1.5.0 Renamed the "timeout" option to "socketTimeoutMS".
1.3.0 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.

Примеры

Пример #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
PHP Manual