Update Documents

項目一覧

Overview

サンプルデータ
アップデート操作
1 つのドキュメントの更新例
多数のドキュメントの更新例
更新操作をカスタマイズする
戻り値
詳細情報
API ドキュメント

Overview

このガイドでは、 Scalaドライバーを使用してMongoDBコレクション内のドキュメントを更新する方法を学習できます。これには、updateOne() メソッドと updateMany() メソッドが使用されます。

サンプルデータ

このガイドの例では、restaurants sample_restaurantsAtlasサンプルデータセットのデータベースのコレクションを使用します。 Scalaアプリケーションからこのコレクションにアクセスするには、AtlasMongoClient クラスターに接続するを作成し、変数と変数に次の値を割り当てます。databasecollection

val database: MongoDatabase = mongoClient.getDatabase("sample_restaurants")
val collection: MongoCollection[Document] = database.getCollection("restaurants")

MongoDB Atlasクラスターを無料で作成して、サンプルデータセットをロードする方法については、「Atlas を使い始める」ガイドを参照してください。

アップデート操作

次の方法を使用して、MongoDB 内のドキュメントを更新できます。

updateOne()は、検索条件に一致する最初のドキュメントを更新します。
updateMany()は、検索条件に一致するすべてのドキュメントを更新します

各更新方法には次のパラメーターが必要です。

クエリフィルター 。アップデートするドキュメントに一致します。クエリフィルターの詳細については、「クエリの指定」ガイドをご覧ください。
ドキュメント を更新し、更新演算子と更新するフィールドと値を指定します。更新演算子は、実行する更新のタイプを指定します。更新演算子のリストを表示し、その使用方法については、 MongoDB Serverマニュアルの「フィールド更新演算子」のガイドページを参照してください。

1 つのドキュメントの更新例

次の例では、 updateOne() メソッドを使用して、ドキュメントの nameフィールドの値を "Happy Garden" から "Mountain House" に更新します。アップデートドキュメントでは、 set() メソッドを使用して nameフィールド値をアップデートします。

val filter = equal("name", "Happy Garden")
val update = set("name", "Mountain House")
val observable: Observable[UpdateResult] = collection.updateOne(filter, update)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 1
Completed

多数のドキュメントの更新例

次の例では、 updateMany() メソッドを使用して、nameフィールド値が "Starbucks" であるすべてのドキュメントを更新します。アップデートドキュメントでは、 rename() メソッドを使用して、addressフィールドの名前を location に変更します。

val filter = equal("name", "Starbucks")
val update = rename("address", "location")
val observable: Observable[UpdateResult] = collection.updateMany(filter, update)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 11
Completed

更新操作をカスタマイズする

updateOne()メソッドとupdateMany()メソッドは、更新操作を構成するためのオプションを設定するパラメーターをオプションで受け入れます。オプションを指定しない場合、ドライバーはデフォルト設定で更新操作を実行します。

次の表では、 UpdateOptionsインスタンスを構成するために使用できる setter メソッドについて説明します。

方式	説明
`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`
`sort()`	Sets the sort criteria to apply to the operation. If multiple documents match the query filter that you pass to the `updateOne()` method, the operation updates the first result. You can set this option to apply an order to matched documents to have more control over which document is updated.
`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()`	Provides a list of filters that you specify to select which array elements the update applies to.
`hint()`	Sets the index to use when matching documents. For more information, see the hint statement in the MongoDB Server manual.
`let()`	Provides a map of parameter names and values to set top-level variables for the operation. 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()`	Sets a comment to attach to the operation. For more information, see the update command fields guide in the MongoDB Server manual for more information.

変更更新の例

この例では、オプションを作成し、updateOne() メソッドに渡します。この例では、 equal()ヘルパーメソッドを使用して、nameフィールドの値が "Sunrise Pizzeria" であるドキュメントを一致させます。次に、set() メソッドを使用して、最初に一致するドキュメントの boroughフィールド値を "Queens" に設定し、cuisineフィールド値を "Italian" に設定します。このコードでは、 combine() メソッドを使用して、1 つの更新ドキュメントで複数の更新を指定します。

UpdateOptionsインスタンスでは upsert オプションは true に設定されているため、クエリフィルターが既存のドキュメントと一致しない場合、フィルターとアップデートドキュメントで指定されたフィールドと値を持つ新しいドキュメントをドライバーは挿入します。

val filter = equal("name", "Sunrise Pizzeria")
val opts = UpdateOptions().upsert(true)
val update = combine(
  set("borough", "Queens"),
  set("cuisine", "Italian")
)
val observable: Observable[UpdateResult] = collection.updateOne(filter, update, opts)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit =
      println(s"Updated document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Updated document count: 1
Completed

戻り値

updateOne()メソッドとupdateMany()メソッドはそれぞれUpdateResultオブジェクトを返します。 UpdateResultインスタンスからの情報にアクセスするには、次のメソッドを使用できます。

方式	説明
`getMatchedCount()`	Returns the number of documents that matched the query filter, regardless of how many updates were performed.
`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.
`wasAcknowledged()`	Returns `true` if the server acknowledged the result.
`getUpsertedId()`	Returns the `_id` value of the document that was upserted in the database, if the driver performed an upsert.

注意

wasAcknowledged()メソッドがfalseを返す場合、 UpdateResultインスタンスから他の情報にアクセスしようとすると、 InvalidOperation例外が発生します。サーバーが書込み (write) 操作を確認しない場合、ドライバーはこれらの値を決定できません。

詳細情報

Scalaドライバーを使用してドキュメントを更新する方法を示す実行可能なコード例については、「 MongoDBへのデータの書込み」を参照してください。

API ドキュメント

このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。

戻る

置換

削除