MongoGridFS::delete

(PECL mongo >=1.0.8)

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

説明

public MongoGridFS::delete ( mixed $id ) : bool|array

注意:
MongoGridFS::delete() は利便性のためのメソッドで、 MongoGridFS::remove() に特定の criteria を指定して、デフォルトの options で呼び出すのと同じ動きをします。

パラメータ

id: 削除したいファイルの _id。

返り値

書き込み確認を適用している場合は、配列を返します。この配列には、削除が成功したかどうか (files コレクションを尊重したもの) を含みます。それ以外の場合は TRUE を返します。

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

エラー / 例外

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

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

add a note

User Contributed Notes 1 note

down

-1

mshallop+php-at-gmail-dot-com ¶

10 years ago


Doc doesn't explicitly state what is returned. 

Returns an array:

{ 
  n => {integer value}  (number of records deleted),
  connectionID => { integer value }
  err => null or error text/code
  ok => 1 or 0 
}

Sample output:

{ n : 1, connectionID : 33132, err : null, ok : 1 }

add a note