Update Documents
Overview
このガイドでは、 MongoDB PHPライブラリを使用してMongoDBコレクション内のドキュメントを更新する方法を学習できます。単一のドキュメントを更新するには MongoDB\Collection::updateOne()メソッドを呼び出し、複数のドキュメントを更新するにはMongoDB\Collection::updateMany()メソッドを呼び出します。
サンプル データ
このガイドの例では、 Atlasサンプルデータセットのsample_restaurantsデータベースのrestaurantsコレクションを使用します。 PHPアプリケーションからこのコレクションにアクセスするには、Atlas クラスターに接続するMongoDB\Clientをインスタンス化し、 $collection変数に次の値を割り当てます。
$collection = $client->sample_restaurants->restaurants;
MongoDB Atlasクラスターを無料で作成して、サンプルデータセットをロードする方法については、 「Atlas を使い始める」ガイドを参照してください。
アップデート操作
MongoDB では、次の方法で更新操作を実行できます。
MongoDB\Collection::updateOne()は、検索条件に一致する最初のドキュメントを更新します。MongoDB\Collection::updateMany()は、検索条件に一致するすべてのドキュメントを更新します
各更新方法には次のパラメーターが必要です。
クエリフィルタードキュメント: 更新するドキュメントを指定します。クエリフィルターの詳細については、 MongoDB Serverマニュアルの「クエリフィルター ドキュメント 」セクションを参照してください。
ドキュメントの更新:更新演算子、または実行する更新の種類と、変更するフィールドと値を指定します。更新演算子とその使用方法のリストについては、 MongoDB Serverマニュアルの「フィールド更新演算子 」のガイドを参照してください。
1 つのドキュメントの更新
次の例では、 updateOne()メソッドを使用して、 restaurantsコレクション内のドキュメントのname値を'Bagels N Buns'から'2 Bagels 2 Buns'に更新します。
$result = $collection->updateOne( ['name' => 'Bagels N Buns'], ['$set' => ['name' => '2 Bagels 2 Buns']] );
多くのドキュメントの更新
次の例では、 updateMany()メソッドを使用して、 cuisineの値が'Pizza'であるすべてのドキュメントを更新します。更新後、ドキュメントのcuisine値は'Pasta'になります。
$result = $collection->updateMany( ['cuisine' => 'Pizza'], ['$set' => ['cuisine' => 'Pasta']] );
更新操作をカスタマイズする
オプション値を指定する配列をパラメーターとして渡すことで、 updateOne()メソッドとupdateMany()メソッドの動作を変更できます。次の表では、 配列に設定できるオプションの一部を説明しています。
オプション | 説明 |
|---|---|
upsert | Specifies whether the update operation performs an upsert operation if no
documents match the query filter. For more information, see the upsert
statement
in the MongoDB Server manual. Defaults to false. |
bypassDocumentValidation | Specifies whether the update operation bypasses document validation. This lets you
update documents that don't meet the schema validation requirements, if any
exist. For more information about schema validation, see Schema
Validation in the MongoDB
Server manual. Defaults to false. |
collation | Specifies the kind of language collation to use when sorting
results. For more information, see Collation
in the MongoDB Server manual. |
arrayFilters | Specifies which array elements an update applies to if the operation modifies
array fields. |
hint | Sets the index to scan for documents.
For more information, see the hint statement
in the MongoDB Server manual. |
writeConcern | Sets the write concern for the operation.
For more information, see Write Concern
in the MongoDB Server manual. |
let | Specifies a document with a list of values to improve operation readability.
Values must be constant or closed expressions that don't reference document
fields. For more information, see the let statement in the
MongoDB Server manual. |
comment | A comment to attach to the operation. For more information, see the insert command
fields guide in the
MongoDB Server manual. |
次の例では、 updateMany()メソッドを使用して、 boroughの値が'Manhattan'であるすべてのドキュメントを検索します。次に、これらのドキュメントのborough値を'Manhattan (north)'にアップデートします。 upsertオプションがtrueに設定されているため、クエリフィルターが既存のドキュメントと一致しない場合、 MongoDB PHPライブラリは新しいドキュメントを挿入します。
$result = $collection->updateMany( ['borough' => 'Manhattan'], ['$set' => ['borough' => 'Manhattan (north)']], ['upsert' => true] );
戻り値
updateOne()メソッドとupdateMany()メソッドはMongoDB\UpdateResultクラスのインスタンスを返します。このクラスには、次のメンバー関数が含まれています。
関数 | 説明 |
|---|---|
getMatchedCount() | Returns the number of documents that matched the query filter, regardless of
how many were updated. |
getModifiedCount() | Returns the number of documents modified by the update operation. If an updated
document is identical to the original, it is not included in this
count. |
isAcknowledged() | Returns a boolean indicating whether the write operation was acknowledged. |
getUpsertedCount() | Returns the number of document that were upserted into the database. |
getUpsertedId() | Returns the ID of the document that was upserted in the database, if the driver
performed an upsert. |
次の例では、 updateMany()メソッドを使用して、一致するドキュメントのnameフィールドを'Dunkin' Donuts'から'Dunkin''にアップデートします。変更されたドキュメントの数を出力するには、 getModifiedCount()メンバー関数を呼び出します。
$result = $collection->updateMany( ['name' => 'Dunkin\' Donuts'], ['$set' => ['name' => 'Dunkin\'']] ); echo 'Modified documents: ', $result->getModifiedCount();
詳細情報
クエリフィルターの作成の詳細については、「 クエリの指定」ガイドを参照してください。
API ドキュメント
このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。