MongoCollection
PHP Manual

MongoCollection::remove

(PECL mongo >=0.9.0)

MongoCollection::removeレコードをコレクションから削除する

説明

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

パラメータ

criteria

削除したいレコードの条件。

options

削除時のオプション。

  • "justOne"

    条件にマッチするレコードを 1 件だけ削除します。

  • "safe"

    削除に成功したかどうか、何件のアイテムが削除されたかをチェックします。

返り値

"safe" が設定されているときは、削除の状況 ("ok") と削除されたアイテム数 ("n") そして発生したエラー ("err") を連想配列で返します。設定されていないときは、削除の送信に成功すれば TRUE、失敗すれば FALSE を返します。

エラー / 例外

"safe" オプションが設定されていて削除に失敗した場合に MongoCursorException をスローします。

変更履歴

バージョン 説明
1.0.5 二番目のパラメータがオプションの配列に変わりました。1.0.5 より前のバージョンでは、二番目のパラメータは "justOne" オプションを表す boolean 値で、safe オプションはありませんでした。

例1 MongoCollection::remove() で justOne を使う例

<?php

$radioactive 
$db->radioactive;

// プルトニウムがあとどれだけ残っているかを数えます
$remaining $radioactive->count(array('type' => 94));

$halflife $remaining/2;

// それを半減させます
while ($halflife 0) {
    
$uranium->remove(array('type' => 94), array("justOne" => true));
    
$halflife--;
}

?>

参考

MongoDB コアドキュメントの » remove を参照ください。


MongoCollection
PHP Manual