MongoDB\Database::getGridFSBucket()

定義

MongoDB\Database::getGridFSBucket()

データベース内のGridFSバケットへのアクセス権を取得します。このメソッドはMongoDB\Database::selectGridFSBucket() のエイリアスであり、将来のリリースで置き換えられます。

function getGridFSBucket(array $options = []): MongoDB\GridFS\Bucket

パラメーター

$options : 配列

必要なオプションを指定する配列。

名前	タイプ	説明
bucketName	string	ファイルとチャンクコレクションのプレフィックスとして使用されるバケット名。デフォルトは`"fs"`です。
chunkSizeBytes	integer	バイト単位でのチャンクサイズ。デフォルトは `261120`（255 KinB）です。
コーデック	MongoDB\Codec\DocumentCodec	ファイルドキュメントを返すバケットメソッドに使用するデフォルトのタイプコーデックでデータをエンコードする（`MongoDB\GridFS\Bucket::find()` など）。バージョン1.17の新機能。
ReadConcern	MongoDB\Driver\ReadConcern	バケット操作に使用するデフォルトの読み取り保証 (read concern) です。デフォルトは、データベースの読み取り保証 (read concern) です。
readPreference	MongoDB\Driver\ReadPreference	バケット操作に使用するデフォルトの読み込み設定 (read preference) 。データベースの読み込み設定 (read preference)がデフォルトで設定されます。
typeMap	配列	バケット操作に使用するデフォルトのタイプマップ。データベースのタイプマップがデフォルトで設定されます。
writeConcern	MongoDB\Driver\WriteConcern	バケット操作に使用するデフォルトの書込み保証 (write concern) です。データベースの書込み保証 (write concern) のデフォルト。

Return Values

getGridFSBucket()メソッドはMongoDB\GridFS\Bucket オブジェクトを返します。

エラーと例外

MongoDB\Exception\InvalidArgumentException は、パラメータまたはオプションの解析に関連するエラーの場合はです。

動作

選択されたバケットは、オブジェクトから読み込み設定Database$options (read preference)やタイプマッピングなどのオプションを継承します。パラメータを使用してオプションを上書きできます。

例

次の例では、testデータベース内のデフォルトの fs.filesバケットにアクセスします。

<?php
$db = (new MongoDB\Client)->test;
$bucket = $db->getGridFSBucket();

次の例では、カスタム読み込み設定 (read preference)を使用して、testデータベース内のカスタム images.filesバケットにアクセスします。

<?php
$db = (new MongoDB\Client)->test;
$imagesBucket = $db->getGridFSBucket([
    'bucketName' => 'images',
    'readPreference' => new MongoDB\Driver\ReadPreference('primaryPreferred'),
]);

その他の参照

Overview