MongoDB$ClientBulkWrite::withCollection()

定義

MongoDB\ClientBulkWrite::withCollection()

MongoDB\ClientBulkWrite提供された インスタンスからMongoDB\Collection の更新されたインスタンスを返します。このメソッドを使用すると、ClientBulkWrite が作成されたコレクションとは異なるコレクションに対して、後続の書込み操作を追加できます。

このメソッドは新しいBulkWriteCommand を構築せず、ClientBulkWriteインスタンスをその場で編集しません。

function withCollection(
    Collection $collection,
): self

ClientBulkWriteインスタンスでこのメソッドを呼び出す場合、異なる Manager オブジェクトに関連付けられている Collection インスタンスを混在させることはできません。これは、ライブラリが完了した BulkWriteCommand を単一のサーバーに送信するためです。

パラメーター

$collection : MongoDB\Collection

withCollection() を呼び出した後に ClientBulkWriteインスタンスに追加された書込み操作のターゲットとして設定する Collectionインスタンス。

Return Values

同じ BulkWriteCommand 仕様と 更新された ターゲット名前空間を持つ新しい ClientBulkWriteインスタンス。

エラーと例外

MongoDB\Exception\UnsupportedExceptionオプションが使用され、選択したサーバーでサポートされていない場合（例: collation 、 readConcern 、 writeConcern ）。

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

MongoDB$Driver\Exception\RuntimeException は、拡張レベルの他のエラーの場合（例:）。

その他の参照

• 一括書き込み操作ガイドのクライアント一括書き込みセクション