PHP 5.6.0 released

MongoGridFS::delete

(PECL mongo >=1.0.8)

MongoGridFS::deleteRemove a file and its chunks from the database

Description

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

Note:

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

Parameters

id

_id of the file to remove.

Return Values

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().

Errors/Exceptions

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.

add a note add a note

User Contributed Notes 1 note

up
0
mshallop+php-at-gmail-dot-com
1 month 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 }
To Top