MongoGridFS::storeFile
(PECL mongo >=0.9.0)
MongoGridFS::storeFile — Stores a file in the database
Description
$filename
[, array $metadata = array()
[, array $options = array()
]] )Parameters
-
filename -
Name of the file to store.
-
metadata -
Other metadata fields to include in the file document.
Note:
These fields may also overwrite those that would be created automatically by the driver, as described in the MongoDB core documentation for the » files collection. Some practical use cases for this behavior would be to specify a custom chunkSize or _id for the file.
-
options -
Options for the store.
"w"
See Write Concerns. The default value for MongoClient is 1.
Return Values
Returns the _id of the saved file document. This will be a generated MongoId unless an _id was explicitly specified in the extra parameter.
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.
Examples
Example #1 MongoGridFS::storeFile() with additional metadata
<?php
$m = new MongoClient();
$gridfs = $m->selectDB('test')->getGridFS();
$id = $gridfs->storeFile('example.txt', array('contentType' => 'plain/text'));
$gridfsFile = $gridfs->get($id);
var_dump($gridfsFile->file);
?>
The above example will output something similar to:
array(7) {
["_id"]=>
object(MongoId)#6 (0) {
}
["contentType"]=>
string(10) "plain/text"
["filename"]=>
string(11) "example.txt"
["uploadDate"]=>
object(MongoDate)#7 (0) {
}
["length"]=>
int(26)
["chunkSize"]=>
int(262144)
["md5"]=>
string(32) "c3fcd3d76192e4007dfb496cca67e13b"
}
See Also
- MongoGridFS::put() - Stores a file in the database
- MongoGridFS::storeBytes() - Stores a string of bytes in the database
- MongoGridFS::storeUpload() - Stores an uploaded file in the database
- MongoDB core docs on » GridFS
- 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
Коментарии
Pass
$options['safe'] = true;
to make Mongo slow down and do inserts sequentially instead of in parallel.
Use case:
I had 274 PDF documents stored on ext3 disk (avg. size was 5MB, none over 20MB)
A PHP loop loaded each PDF, then did a $GridFS->storeFile( $data, $meta );
This caused server to spike from load average of 0.2 to over 20.0
Apparently what was happening is the loop slammed Mongo (then memory, disk) with 274 convert/stores to do all at once.
Adding
$GridFS->storeFile( $data, $meta, array( 'safe' => true ) );
made the loop slow down and wait for each insert to finish and be confirmed before going on to next PDF.
Moral: Safe option can be used to maintain sanity and is not always just for data validity.