MongoGridFS::delete

(PECL mongo >=1.0.8)

MongoGridFS::delete — Remove a file and its chunks from the database

说明

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

Note:
MongoGridFS::delete() is a convenience method for calling MongoGridFS::remove() with specific criteria and default options parameters.

参数

id: _id of the file to remove.

返回值

Returns an array containing the status of the removal (with respect to the files collection) if a write concern is applied. Otherwise, returns TRUE.

Fields in the status array are described in the documentation for MongoCollection::insert().

错误／异常

Throws MongoCursorException if the "w" option is set and the write fails.

Throws MongoCursorTimeoutException if the "w" option is set to a value greater than one and the operation takes longer than MongoCursor::$timeout milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in MongoCollection::$wtimeout is milliseconds.

User Contributed Notes

mshallop+php-at-gmail-dot-com 24-Jul-2014 01:09


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 }