MongoDB\GridFS\Bucket::__construct()

定義

MongoDB\GridFS\Bucket::__construct()

新しい Bucketインスタンスを構築します。

function __construct(
    MongoDB\Driver\Manager $manager,
    string $databaseName,
    array $options = []
)

パラメーター

$manager : MongoDB\Driver\Manager

拡張機能からの マネージャーインスタンス。マネージャーはドライバーとMongoDBの間の接続を維持します。

$databaseName : string

データベースの名前。

$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 preference) です。
typeMap	配列	カーソルに適用するデフォルトのタイプ マップ。BSON ドキュメントをPHP値に変換する方法を決定します。ライブラリは、デフォルトで次の型マップを使用します。 [ 'array' => 'MongoDB\Model\BSONArray', 'document' => 'MongoDB\Model\BSONDocument', 'root' => 'MongoDB\Model\BSONDocument', ]
writeConcern	MongoDB\Driver\WriteConcern	バケット操作に使用するデフォルトの書込み保証 (write concern) です。 デフォルトは、マネージャーの書込み保証 (write concern) です。

エラーと例外

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

動作

バケットを明示的に構築すると、バケットはMongoDB$Driver\Managerオブジェクトからすべてのオプションを継承します。Databaseオブジェクトからバケットを選択した場合、バケットはそのオブジェクトからオプションを継承します。

例

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

出力は次のようになります。

object(MongoDB\GridFS\Bucket)#3053 (2) {
  ["bucketName"]=>
  string(4) "test"
  ["databaseName"]=>
  string(11) "phplib_test"
}

その他の参照

• MongoDB\Database::selectGridFSBucket()