大きなファイルの保存

Overview

このガイドでは、 GridFSを使用してMongoDBに大容量ファイルを保存、検索する方法を学びます。 GridFSとは、 MongoDB PHPライブラリによって実装された仕様で、ファイルを保存するときにチャンクに分裂し、検索時にファイルを再アセンブルする方法を記述します。 ライブラリのGridFSの実装は、ファイルストレージの操作と組織を管理する抽象化です。

ファイルのサイズがBSONドキュメントサイズ制限の16 MB を超える場合は、 GridFSを使用します。 GridFSがユースケースに適しているかどうかの詳細については、 MongoDB Serverマニュアルの GridFSを参照してください。

GridFS の仕組み

GridFS により、ファイルはバケット（ファイルのチャンクとそれを説明する情報を含む MongoDB コレクションのグループ）に整理されます。 バケットには、GridFS の仕様に定義されている規則を使用して名前付けされた、以下のコレクションが含まれています。

• chunks コレクションには、バイナリ ファイルのチャンクがストアされます。

• files コレクションには、ファイルのメタデータがストアされます。

新しいGridFSバケットを作成すると、別の名前を指定しない限り、ライブラリはデフォルトのバケット名fsを先頭に、前述のコレクションを作成します。 ライブラリは各コレクションにインデックスも作成し、ファイルや関連メタデータを効率的に取得できるようにします。 ライブラリは、 GridFSバケットが存在しない場合は、最初の書込み操作が実行されたときにのみ GridFS バケット を作成します。 ライブラリは、インデックスが存在せず、バケットが空の場合にのみインデックスを作成します。 GridFSインデックスの詳細については、 MongoDB Serverマニュアルの「 GridFSインデックス」を参照してください。

GridFSを使用してファイルを保存する場合、ライブラリはファイルを小さなチャンクに分割し、各ファイルはchunksコレクションに個別のドキュメントとして表されます。 また、ファイルID、ファイル名、およびその他のファイルメタデータを含むドキュメントをfilesコレクションに作成します。 MongoDB PHPライブラリにストリームを渡して、新しいストリームを消費または作成し、そのストリームに直接書き込むことで、ファイルをアップロードできます。 ストリームの詳細については、「 ストリーム 」を参照してください。 PHPマニュアルを参照してください。

GridFSがバケットにアップロードされるときにファイルを分割する方法を確認するには、次の図を表示します。

ファイルを検索する際、 GridFSは指定されたバケット内のfilesコレクションからメタデータを取得し、その情報を使用してchunksコレクション内のドキュメントからファイルを再構築します。 ファイルの内容を既存のストリームに書き込むか、ファイルをポイントする新しいストリームを作成することで、ファイルを読み取ることができます。

GridFS バケットの作成

GridFSからファイルを保存または検索するには、データベースでMongoDB\Database::selectGridFSBucket()メソッドを呼び出します。 このメソッドは、既存のバケットにアクセスし、バケットが存在しない場合は新しいバケットを作成します。

次の例では、 dbデータベースでselectGridFSBucket()メソッドを呼び出します。

$bucket = $client->db->selectGridFSBucket();

$custom_bucket = $client->db->selectGridFSBucket(
    ['bucketName' => 'myCustomBucket']
);

ファイルのアップロード

次の方法を使用して、 GridFSバケットにファイルをアップロードできます。

• MongoDB\GridFS\Bucket::openUploadStream(): 新しいアップロードストリームを開き、ファイルの内容を書き込むことができます

• MongoDB\GridFS\Bucket::uploadFromStream(): 既存のストリームの内容をGridFSファイルにアップロードします

$stream = $bucket->openUploadStream('my_file', [
    'metadata' => ['contentType' => 'text/plain']
]);
fwrite($stream, 'Data to store');
fclose($stream);

$file = fopen('/path/to/input_file', 'rb');
$bucket->uploadFromStream('new_file', $file);

ファイル情報の検索

このセクションでは、GridFS バケットの files コレクションにストアされているファイル メタデータを検索する方法を学びます。メタデータには、参照先のファイルに関する次のような情報が含まれます。

• ファイルの _id

• ファイルの名前

• ファイルの長さ/サイズ

• アップロード日時

• その他の情報をストアできる metadata ドキュメント

GridFSバケットからファイルを検索するには、 MongoDB\GridFS\BucketインスタンスでMongoDB\GridFS\Bucket::find()メソッドを呼び出します。 このメソッドは、結果にアクセスできるMongoDB\Driver\Cursorインスタンスを返します。 MongoDB PHPライブラリの Cursorオブジェクトの詳細については、「カーソルからのデータへのアクセス」ガイドを参照してください。

$files = $bucket->find();
foreach ($files as $file_doc) {
    echo toJSON($file_doc), PHP_EOL;
}

{ "_id" : { "$oid" : "..." }, "chunkSize" : 261120, "filename" : "my_file",
"length" : 13, "uploadDate" : { ... }, "metadata" : { "contentType" : "text/plain" },
"md5" : "6b24249b03ea3dd176c5a04f037a658c" }
{ "_id" : { "$oid" : "..." }, "chunkSize" : 261120, "filename" : "new_file",
"length" : 13, "uploadDate" : { ... }, "md5" : "6b24249b03ea3dd176c5a04f037a658c" }

function toJSON(object $document): string
{
    return MongoDB\BSON\Document::fromPHP($document)->toRelaxedExtendedJSON();
}

ファイルのダウンロード

次の方法を使用して、 GridFSバケットからファイルをダウンロードできます。

• MongoDB\GridFS\Bucket::openDownloadStreamByName() またはMongoDB\GridFS\Bucket::openDownloadStream() : 新しいダウンロードストリームを開き、ファイルの内容を読み取ることができる

• MongoDB\GridFS\Bucket::downloadToStream():ファイル全体を既存のダウンロード ストリームに書き込みます

$stream = $bucket->openDownloadStreamByName('my_file');
$contents = stream_get_contents($stream);
echo $contents, PHP_EOL;
fclose($stream);

"Data to store"

$stream = $bucket->openDownloadStream(new ObjectId('66e0a5487c880f844c0a32b1'));
$contents = stream_get_contents($stream);
fclose($stream);

$stream = $bucket->openDownloadStreamByName('my_file', ['revision' => 0]);
$contents = stream_get_contents($stream);
fclose($stream);

$file = fopen('/path/to/output_file', 'wb');
$bucket->downloadToStream(
	new ObjectId('66e0a5487c880f844c0a32b1'),
	$file,
);

ファイル名の変更

バケット内のGridFSファイルの名前を更新するには、MongoDB\GridFS\Bucket::rename() メソッドを使用します。次のパラメータを rename() メソッドに渡します。

• _id 名前を変更するファイルの 値

• 新しいファイル名

次の例では、ファイルの _id 値を参照して filenameフィールドを 'new_file_name' に更新する方法を示します。

$bucket->rename(new ObjectId('66e0a5487c880f844c0a32b1'), 'new_file_name');

または、MongoDB\GridFS\Bucket::renameByName() メソッドを使用して、 GridFSファイルとそのファイルの変更内容の名前を変更することもできます。次のパラメータを renameByName() メソッドに渡します。

• filename 変更する値

• 新しいファイル名

次の例では、filename の値が 'my_file' であるすべてのファイルの名前を変更します。

$bucket->renameByName('my_file', 'new_file_name');

ファイルの削除

GridFSファイルのコレクションドキュメントと関連するチャンクをバケットから削除するには、MongoDB\GridFS\Bucket::delete() メソッドを使用します。これにより、ファイルが実質的に削除されます。削除するファイルの _id 値をパラメーターとして delete() メソッドに渡します。

次の例は、_id フィールドを参照してファイルを削除する方法を示しています。

$bucket->delete(new ObjectId('66e0a5487c880f844c0a32b1'));

または、MongoDB\GridFS\Bucket::deleteByName() メソッドを使用してGridFSファイルとそのファイルの変更をすべて削除することもできます。次のコードに示すように、削除するファイルの filename 値をパラメーターとして deleteByName() メソッドに渡します。

$bucket->deleteByName('my_file');

API ドキュメント

MongoDB PHPライブラリを使用して大容量のファイルを保存および検索する方法の詳細については、次のAPIドキュメントを参照してください。

• MongoDB\Database::selectGridFSBucket()

• MongoDB\GridFS\Bucket::openUploadStream()

• MongoDB\GridFS\Bucket::uploadFromStream()

• MongoDB\GridFS\Bucket::find()

• MongoDB\GridFS\Bucket::openDownloadStreamByName()

• MongoDB\GridFS\Bucket::openDownloadStream()

• MongoDB\GridFS\Bucket::downloadToStream()

• MongoDB\GridFS\Bucket::rename()

• MongoDB\GridFS\Bucket::delete()