PHP - Manual: MongoGridFS

2024-12-22

The MongoGridFS class

(PECL mongo >=0.9.0)

简介

Utilities for storing and retrieving files from the database.

GridFS is a storage specification all supported drivers implement. Basically, it defines two collections: files, for file metadata, and chunks, for file content. If the file is large, it will automatically be split into smaller chunks and each chunk will be saved as a document in the chunks collection.

Each document in the files collection contains the filename, upload date, and md5 hash. It also contains a unique _id field, which can be used to query the chunks collection for the file's content. Each document in the chunks collection contains a chunk of binary data, a files_id field that matches its file's _id, and the position of this chunk in the overall file.

For example, the files document is something like:


<?php
array("_id" => 123456789, "filename" => "foo.txt", "chunkSize" => 3, "length" => 12);
?>

and the chunks documents look like:


<?php
array("files_id" => 123456789, "n" => 0, "data" => new MongoBinData("abc"));
array("files_id" => 123456789, "n" => 1, "data" => new MongoBinData("def"));
array("files_id" => 123456789, "n" => 2, "data" => new MongoBinData("ghi"));
array("files_id" => 123456789, "n" => 3, "data" => new MongoBinData("jkl"));
?>

Of course, the default chunk size is thousands of bytes, but that makes an unwieldy example.

Inter-Language Compatibility

You should be able to use any files created by MongoGridFS with any other drivers, and vice versa. However, some drivers expect that all metadata associated with a file be in a "metadata" field. If you're going to be using other languages, it's a good idea to wrap info you might want them to see in a "metadata" field. For example, instead of:


<?php

$grid->storeFile("somefile.txt", array("date" => new MongoDate()));

?>

use something like:


<?php

$grid->storeFile("somefile.txt", array("metadata" => array("date" => new MongoDate())));

?>

The MongoGridFS Family

MongoGridFS represents the files and chunks collections. MongoGridFS extends MongoCollection, and an instance of MongoGridFS has access to all of MongoCollection methods, which act on the files collection:


<?php

$grid = $db->getGridFS();
$grid->update(array("filename" => "foo"), $newObj); // update on the files collection

?>

Another example of manipulating metadata:


<?php

// save a file
$id = $grid->storeFile("game.tgz");
$game = $grid->findOne();

// add a downloads counter
$game->file['downloads'] = 0;
$grid->save($game->file);

// increment the counter
$grid->update(array("_id" => $id), array('$inc' => array("downloads" => 1)));

?>

You can also access the chunks collection from an instance of MongoGridFS:


<?php

  $chunks = $grid->chunks; // $chunks is a normal MongoCollection
$chunks->insert(array("x" => 4));

?>

There are some methods for MongoGridFS with the same name as MongoCollection methods, that behave slightly differently. For example, MongoGridFS::remove() will remove any objects that match the criteria from the files collection and their content from the chunks collection.

To store something new in GridFS, there are a couple options. If you have a filename, you can say:


<?php

$grid->storeFile($filename, array("whatever" => "metadata", "you" => "want"));

?>

If you have a string of bytes that isn't a file, you can also store that using MongoGridFS::storeBytes():


<?php

$grid->storeBytes($bytes, array("whatever" => "metadata", "you" => "want"));

?>

Querying a MongoGridFS collection returns a MongoGridFSCursor, which behaves like a normal MongoCursor except that it returns MongoGridFSFiles instead of associative arrays.

MongoGridFSFiles can be written back to disc using MongoGridFSFile::write() or retrieved in memory using MongoGridFSFile::getBytes(). There is currently no method that automatically streams chunks, but it would be fairly easy to write by querying the $grid->chunks collection.

MongoGridFSFile objects contain a field file which contains any file metadata.

类摘要

extends MongoCollection {

/* Fields */

public MongoCollection $chunks = NULL ;

protected string $filesName = NULL ;

protected string $chunksName = NULL ;

/* 方法 */

public __construct ( MongoDB $db [, string $prefix = "fs" [, mixed $chunks = "fs" ]] )

public delete ( mixed $id ) : bool|array

public drop ( void ) : array

public find ([ array $query = array() [, array $fields = array() ]] ) : MongoGridFSCursor

public findOne ([ mixed $query = array() [, mixed $fields = array() ]] ) : MongoGridFSFile

public get ( mixed $id ) : MongoGridFSFile

public put ( string $filename [, array $metadata = array() [, array $options = array() ]] ) : mixed

public remove ([ array $criteria = array() [, array $options = array() ]] ) : bool|array

public storeBytes ( string $bytes [, array $metadata = array() [, array $options = array() ]] ) : mixed

public storeFile ( string|resource $filename [, array $metadata = array() [, array $options = array() ]] ) : mixed

public storeUpload ( string $name [, array $metadata ] ) : mixed

}

参见

MongoDB core docs on » GridFS
LightCube Solutions blog post on » saving user uploads
LightCube Solutions blog post on » adding metadata to files

MongoGridFS::__construct — Creates new file collections
MongoGridFS::delete — Remove a file and its chunks 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 — Remove files and their chunks from the database
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

add a note

User Contributed Notes

There are no user contributed notes for this page.

官方地址：https://www.php.net/manual/en/class.mongogridfs.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言 Linux 开发编程科技 Elasticsearch HTML/CSS/XML 网络数据库 JAVA 面试 NoSQL C/C++ Golang Git 算法操作系统正则表达式 Redis 互联网 MySql JavaScript 运维软件国际架构设计 Mac OS TCP/IP Excel Vim Windows Socket Oracle VR MongoDB Python 运营 MemCache 商业硬件电子娱乐设计 nginx 摄影游戏 WordPress HTTP 团建数码电器

php7 安装fileinfo扩展 preg_split — 通过一个正则表达式分隔字符串 php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题 [PHP] inet_pton/inet_ntop IP地址转换函数 PHP 8.1 [鸟哥]PHP_INT_MIN 和 -9223372036854775808 ADORecordSet对象 adodb手册 opcache预加载 Composer的Packagist资源 array_multisort() 多字段排序 PHPMailer设置utf8 PHPMailer字符集CharSet mysql面试题 PHP json解析（json_decode）页面工具 php中几种注释规范纯php实现DES以及TripleDES加密算法 PHP5 扩展SOAP 调用 webservice [鸟哥]PHP FFI详解 - 一种全新的PHP扩展方式 [原创]诡异的php-fpm超时问题两千行PHP学习笔记

略微加速

PHP官方手册 - 互联网笔记

The MongoGridFS class

简介

Inter-Language Compatibility

The MongoGridFS Family

类摘要

参见

Table of Contents

User Contributed Notes