ドキュメントの置換

項目一覧

Overview

サンプルデータ
置換操作
必要なパラメーター
1 つのドキュメントの置換
置換操作をカスタマイズする
戻り値
詳細情報
API ドキュメント

Overview

このガイドでは、 Scalaドライバーを使用してMongoDBコレクション内のドキュメントに対して置換操作を実行する方法を学習できます。置換操作すると、指定されたドキュメントから_id フィールドを除くすべてのフィールドと値が削除され、指定した新しいフィールドと値が追加されます。この操作は、1 つ以上のドキュメントの指定されたフィールドのみを変更する更新操作とは異なります。

更新操作について詳しくは、ドキュメントの更新のガイドを参照してください。

サンプルデータ

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

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

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

置換操作

MongoDBでは、replaceOne() メソッドを使用して置換操作を実行できます。このメソッドは、指定されたクエリフィルターに一致する最初のドキュメントから _idフィールドを除くすべてのフィールドを削除します。次に、指定したフィールドと値が空のドキュメントに追加されます。

必要なパラメーター

次のパラメータをreplaceOne()メソッドに渡す必要があります。

クエリフィルター。アップデートするドキュメントに一致する。クエリフィルターの詳細については、「クエリの指定」ガイドを参照してください。
置換ドキュメント。既存のフィールドと値を置き換えるフィールドと値を指定します。

1 つのドキュメントの置換

次の例では、 replaceOne() メソッドを使用して、nameフィールドの値が "Primola Restaurant" であるドキュメントのフィールドと値を置き換えます。

val filter = equal("name", "Primola Restaurant")
val replacement = Document(
  "name" -> "Frutti Di Mare",
  "borough" -> "Queens",
  "cuisine" -> "Seafood",
  "owner" -> "Sal Thomas"
)
val observable: Observable[UpdateResult] = collection.replaceOne(filter, replacement)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit = println(s"Replaced document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Replaced document count: 1
Completed

重要

_idフィールドの値は不変です。置き換えドキュメントで_idフィールドの値を指定する場合、既存のドキュメントの _id 値と同じである必要があります。そうでない場合、ドライバーは WriteError を発生させます。

置換操作をカスタマイズする

replaceOne() メソッドは、オプションで ReplaceOptionsデータ型のパラメータを受け入れます。 ReplaceOptionsクラスには、置換オプションを構成するために使用できる setter メソッドが含まれています。オプションを指定しない場合、ドライバーはデフォルト設定で置換操作を実行します。

次の表では、ReplaceOptionsクラスの setter メソッドを説明しています。

方式	説明
`upsert()`	Specifies whether the replace operation performs an upsert operation if no documents match the query filter. For more information, see upsert behavior 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 `replaceOne()` method, the operation replaces the first result. You can set this option to apply an order to matched documents to have more control over which document is replaced.
`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.
`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.
`comment()`	Sets a comment to attach to the operation.

次のコードでは、 upsertオプションをtrueに設定します。これは、クエリフィルターが既存のドキュメントと一致しない場合に、置換ドキュメントで指定されたフィールドと値を持つ新しいドキュメントを挿入するようにドライバーに指示します。

val options = ReplaceOptions().upsert(true)
val observable: Observable[UpdateResult] = collection.replaceOne(filter, replacement, options)
observable.subscribe(new Observer[UpdateResult] {
  override def onNext(result: UpdateResult): Unit = println(s"Replaced document count: ${result.getModifiedCount}")
  override def onError(e: Throwable): Unit = println(s"Failed: ${e.getMessage}")
  override def onComplete(): Unit = println("Completed")
})

Replaced document count: 1
Completed

戻り値

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

方式	説明
`getMatchedCount()`	Returns the number of documents that matched the query filter.
`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 the driver upserted into the database, if any.

詳細情報

ドキュメントを置き換える方法を示す実行可能なコード例については、「 MongoDB へのデータの書込み」を参照してください。

API ドキュメント

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

戻る

Insert

Update