MongoDB$ClientBulkWrite::createWithCollection()

定義

MongoDB\ClientBulkWrite::createWithCollection()

MongoDB\ClientBulkWrite提供された インスタンスからMongoDB\Collection ビルダのインスタンスを作成します。ClientBulkWrite に書込み操作を追加して、ライブラリがサーバーに送信する新しい BulkWriteCommand を作成できます。

function createWithCollection(
    Collection $collection,
    array $options = []
): self

パラメーター

$collection : MongoDB\Collection

一括書き込み操作のターゲットとして設定する Collectionインスタンス。

$options : 配列

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

名前	タイプ	説明
bypassDocumentValidation	ブール値	true の場合: 書込み操作はドキュメントレベルの検証を無視します。 デフォルトは false です。
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。
let	array|object	パラメーター名と値のマップ。 値は、ドキュメント フィールドを参照しない定数または閉じた式である必要があります。 その後、パラメーターには 集計式コンテキスト で変数としてアクセスできます（例: $$var ）。 これは 5.0 より前のサーバー バージョンではサポートされていないため、使用された場合は実行時に例外が発生します。
ordered	ブール値	true の場合: 1 つの書き込みが失敗すると、残りの書き込みを実行せずに操作が停止し、例外がスローされます。 false の場合: 1 つの書き込みが失敗すると、操作は残りの書込み（存在する場合）を続行し、例外をスローします。 デフォルトは true です。
verboseResults	ブール値	冗長な結果を返すかどうかを指定します。 デフォルトは false です。

Return Values

空の BulkWriteCommand 仕様を持つ新しい ClientBulkWriteインスタンス。

エラーと例外

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

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

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

その他の参照

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