MongoGridFS::delete
(PECL mongo >=1.0.8)
MongoGridFS::delete — Remove a file and its chunks from the database
Описание
Замечание:
MongoGridFS::delete() is a convenience method for calling MongoGridFS::remove() with specific
criteriaand defaultoptionsparameters.
Список параметров
-
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().
Ошибки
Исключение MongoCursorException бросается, если установлена опция "w" и не прошла запись.
Исключение MongoCursorTimeoutException бросается, если опция "w" установлена в значение больше одного и операция заняла больше, чем MongoCursor::$timeout миллисекунд. При этом операция на сервере не прерывается, так как это ограничение времени работает на клиентской стороне. Операция в миллисекундах в MongoCollection::$wtimeout.
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для работы с базами данных
- Расширения для работы с базами данных отдельных производителей
- MongoDB
- Классы GridFS
- Функция MongoGridFS::__construct() - Creates new file collections
- Функция MongoGridFS::delete() - Delete a file from the database
- Функция MongoGridFS::drop() - Drops the files and chunks collections
- Функция MongoGridFS::find() - Queries for files
- Функция MongoGridFS::findOne() - Returns a single file matching the criteria
- Функция MongoGridFS::get() - Retrieve a file from the database
- Функция MongoGridFS::put() - Stores a file in the database
- Функция MongoGridFS::remove() - Removes files from the collections
- Функция MongoGridFS::storeBytes() - Stores a string of bytes in the database
- Функция MongoGridFS::storeFile() - Stores a file in the database
- Функция MongoGridFS::storeUpload() - Stores an uploaded file in the database
Коментарии
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 }