MongoDB\Collection::bulkWrite()
定義
パラメーター
$operations
: 配列実行される書込み (write) 操作を含む配列。
MongoDB\Collection::bulkWrite()
は、次の配列構造でMongoDB\Collection::deleteMany()
、MongoDB\Collection::deleteOne()
、MongoDB\Collection::insertOne()
、MongoDB\Collection::replaceOne()
、MongoDB\Collection::updateMany()
、およびMongoDB\Collection::updateOne()
操作をサポートしています。[ [ 'deleteMany' => [ $filter ] ], [ 'deleteOne' => [ $filter ] ], [ 'insertOne' => [ $document ] ], [ 'replaceOne' => [ $filter, $replacement, $options ] ], [ 'updateMany' => [ $filter, $update, $options ] ], [ 'updateOne' => [ $filter, $update, $options ] ], ] 引数は、それぞれの操作メソッドに対応します。 ただし、
writeConcern
オプションは、個々の操作ではなく、MongoDB\Collection::bulkWrite()
の最上位オプションとして指定されます。$options
: 配列必要なオプションを指定する配列。
名前タイプ説明bypassDocumentValidationブール値true
の場合、書込み操作によってドキュメント レベルの検証を回避できます。 デフォルトはfalse
です。コーデックMongoDB\Codec\DocumentCodecドキュメントをエンコードまたはデコードするために使用するコーデック。 このオプションは
typeMap
オプションと相互に排他的です。デフォルトはコレクションのコーデック。 デフォルトの
codec
オプションの継承は、typeMap
オプションの継承よりも優先されます。一括書き込みでは、
insertOne
操作とreplaceOne
操作に コーデックを使用します。バージョン 1.17 の新機能。
comment混合データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。
このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバー バージョンで指定すると実行時に例外が発生します。
バージョン 1.13 の新機能。
letarray|objectパラメーター名と値のマップ。 値は、ドキュメント フィールドを参照しない定数または閉じた式である必要があります。 その後、パラメーターには 集計式コンテキスト で変数としてアクセスできます(例:
$$var
)。これは 5.0 より前のサーバー バージョンではサポートされていないため、使用された場合は実行時に例外が発生します。
バージョン 1.13 の新機能。
orderedブール値true
: 1 つの書き込みが失敗すると、残りの書き込みを実行せずに操作が停止し、例外がスローされます。false
: 1 つの書き込みが失敗すると、操作は残りの書き込みがある場合は続行され、例外がスローされます。デフォルトは
true
です。セッション操作に関連付けるクライアント セッション。
バージョン 1.3 で追加。
writeConcern操作に使用する書込み保証 ( write concern )。 コレクションの書込み保証 (write concern) のデフォルトです。
トランザクションの一部である個々の操作に対して書込み保証 (write concern) を指定することはできません。 代わりに 、トランザクションを開始する ときに
writeConcern
オプションを設定します。
Return Values
MongoDB\BulkWriteResult
MongoDB\Driver\WriteResult をカプセル化する オブジェクト オブジェクト。
エラーと例外
MongoDB\Exception\UnsupportedException
オプションが使用され、選択したサーバーでサポートされていない場合(例: collation
、 readConcern
、 writeConcern
)。
MongoDB\Exception\InvalidArgumentException
は、パラメータまたはオプションの解析に関連するエラーの場合は です。
MongoDB\Driver\Exception\BulkWriteException 書込み (write) 操作に関連するエラーの場合ユーザーは getWriteResult() によって返された値を調べる必要があります。 エラーの内容を判断します。
MongoDB\Driver\Exception\RuntimeException 拡張レベルのその他のエラー(例:)。
動作
MongoDB\Driver\Exception\BulkWriteException の場合 がスローされる場合は、 getWriteResult() を呼び出す必要があります。 返された MongoDB\Driver\WriteResult を検査します エラーの内容を決定するための オブジェクト。
例えば、書込み (write) 操作はプライマリ サーバーに正常に適用されたが、書込み保証 (write concern) を満たすには失敗した場合(例: レプリケーションに時間がかかりすぎました)。 あるいは、書込み (write) 操作が完全に失敗した可能性があります(例: 一意なキー違反)。
一括書込みの場合、結果には複数の書込み操作の成功やエラーが含まれることがあります。 ordered
オプションがtrue
の場合、最初のエラーが発生して例外がスローされる前に一部の操作が成功している可能性があります。 ordered
オプションがfalse
の場合、複数のエラーが発生した可能性があります。