MongoGridFS::put
ファイルをデータベースに格納する
説明
public mixed MongoGridFS::put
( string $filename
[, array $metadata = array()
[, array $options = array()
]] )
注意:
MongoGridFS::put は、 MongoGridFS::storeFile のエイリアスです。
パラメータ
-
filename
-
格納するファイルの名前。
-
metadata
-
格納するファイルに含めるその他のメタデータフィールド。
注意:
これらのフィールドは、ドライバが自動生成したフィールドも上書きします。詳しい説明は、MongoDB コアドキュメントの » files collection を参照ください。この挙動の現実的な使い道としては、ファイルの chunkSize や _id を独自に指定する場合などがあります。
-
options
-
chunks および files
コレクションに対して追加操作を実行するときの、オプションの配列。
オプションの意味については、MongoCollection::insert
を参照ください。
返り値
格納したファイルドキュメントの _id を返します。metadata パラメータで _id を明示的に指定していない場合は、自動生成した MongoId となります。
エラー / 例外
filename の読み込みに失敗したり、
chunks あるいは files
コレクションへの追加に失敗したりした場合に
MongoGridFSException をスローします。
参考
- MongoGridFS::storeBytes
- MongoGridFS::storeFile
- MongoGridFS::storeUpload
- MongoDB コアドキュメントの » GridFS