MongoGridFS::remove

(PECL mongo >=0.9.0)

MongoGridFS::removeファイルとそのチャンクをデータベースから削除する

説明

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

パラメータ

criteria

探したいファイル名あるいは条件。

options

chunks および files コレクションに対して削除操作を実行するときの、オプションの配列。 オプションの意味については、MongoCollection::remove() を参照ください。

返り値

"w" オプションを設定している場合は、配列を返します。 この配列には、削除が成功したかどうか (files コレクションを尊重したもの) を含みます。 それ以外の場合は TRUE を返します。

配列の各フィールドの意味については、 MongoCollection::insert() のドキュメントを参照ください。

エラー / 例外

"w" オプションが設定されていて書き込みが失敗した場合に MongoCursorException をスローします。

"w" オプションの値が 1 より大きく設定されていて、操作の完了までの時間が MongoCursor::$timeout ミリ秒をこえた場合に MongoCursorTimeoutException をスローします。サーバー上での操作は止めません。これはクライアント側でのタイムアウトです。MongoCollection::$wtimeout はミリ秒です。

add a note add a note

User Contributed Notes 1 note

up
0
fhagard at lightcube dot us
14 years ago
To ensure that a remove occurred successfully use MongoDB::lastError(). Currently MongoGridFS::remove will return even if the remove failed.
To Top