MongoDB\Database::selectGridFSBucket()

定義

MongoDB\Database::selectGridFSBucket()

データベース内の GridFS バケットを選択します。

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

パラメーター

$options : 配列

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

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

Return Values

MongoDB\GridFS\Bucketオブジェクト。

エラーと例外

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

動作

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

例

次の例では、 testデータベースでデフォルトのfs.filesバケットを選択しています。

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

次の例では、カスタム読み取り設定を使用して、 testデータベース内のカスタムimages.filesバケットを選択します。

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

その他の参照

• MongoDB\GridFS\Bucket::__construct()