MongoDB\Collection::bulkWrite()

定義

MongoDB\Collection::bulkWrite()

複数の書込み操作を実行します。

function bulkWrite(
    array $operations,
    array $options = []
): MongoDB\BulkWriteResult

パラメーター

$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 : 配列

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

名前	タイプ	説明
builderEncoder	MongoDB\Codec\Encoder	クエリビルダと集計ビルダに使用するエンコード。設定されていない場合、このオプションはデフォルトで `MongoDB\Builder\BuilderEncoder`クラスの新しいインスタンスになります。バージョン1.21の新機能。
bypassDocumentValidation	ブール値	`true`の場合、書込み操作によってドキュメントレベルの検証を回避できます。デフォルトは`false`です。
コーデック	MongoDB\Codec\DocumentCodec	ドキュメントのエンコードまたはデコードに使用するタイプコーデックでデータをエンコードする。このオプションは `typeMap` オプションと相互に排他的です。デフォルトはコレクションのコーデック。デフォルトの`codec`オプションの継承は、 `typeMap`オプションの継承よりも優先されます。一括書き込みでは、 `insertOne`操作と`replaceOne`操作にコーデックを使用します。バージョン 1.17 の新機能。
comment	混合	データベースプロファイラ、 currentOp出力、およびログから操作を追跡するのに役立つ任意のコメントを指定できるようにします。このオプションは MongoDB 4.4 以降で使用可能であり、古いサーバーバージョンで指定すると実行時に例外が発生します。バージョン 1.13 の新機能。
let	array\|object	パラメーター名と値のマップ。値は、ドキュメントフィールドを参照しない定数または閉じた式である必要があります。その後、パラメーターには集計式コンテキストで変数としてアクセスできます（例: `$$var` ）。これは 5.0 より前のサーバーバージョンではサポートされていないため、使用された場合は実行時に例外が発生します。バージョン 1.13 の新機能。
ordered	ブール値	`true` : 1 つの書き込みが失敗すると、残りの書き込みを実行せずに操作が停止し、例外がスローされます。 `false` : 1 つの書き込みが失敗すると、操作は残りの書き込みがある場合は続行され、例外がスローされます。デフォルトは `true` です。
セッション	MongoDB\Driver\Session	操作に関連付けるクライアントセッション。バージョン 1.3 で追加。
writeConcern	MongoDB\Driver\WriteConcern	操作に使用する書込み保証 ( write concern )。コレクションの書込み保証 (write concern) のデフォルトです。トランザクションの一部である個々の操作に対して書込み保証 (write concern)を指定することはできません。代わりに、トランザクションを開始するときに`writeConcern` オプションを設定します。

Return Values

MongoDB\BulkWriteResultMongoDB\Driver\WriteResultオブジェクトをカプセル化するオブジェクト。

エラーと例外

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

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

書込み (write)操作に関連するエラーについては、 MongoDB $Driver\Exception\BulkWriteException を参照してください。ユーザーは getWriteResult() によって返される値を調べて、エラーの内容を判断する必要があります。

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

動作

MongoDB\Driver\Exception\BulkWriteException がスローされた場合、ユーザーは getWriteResult() を呼び出し、返されたMongoDB\Driver\WriteResultオブジェクトを調べて、エラーの内容を判断する必要があります。

例えば、書込み (write) 操作はプライマリサーバーに正常に適用されたが、書込み保証 (write concern) を満たすには失敗した場合（例: レプリケーションに時間がかかりすぎました）。あるいは、書込み (write) 操作が完全に失敗した可能性があります（例: 一意なキー違反）。

一括書込みの場合、結果には複数の書込み操作の成功やエラーが含まれることがあります。 orderedオプションがtrueの場合、最初のエラーが発生して例外がスローされる前に一部の操作が成功している可能性があります。 orderedオプションがfalseの場合、複数のエラーが発生した可能性があります。

その他の参照

戻る

Aggregate()

COUNT()