Update Documents

在此页面上

Overview

样本数据
更新操作
更新一个文档
更新多个文档
自定义更新操作
返回值
更多信息
API 文档

Overview

在本指南中，您可以学习；了解如何使用Kotlin Sync驾驶员通过 updateOne()和updateMany()方法更新MongoDB集合中的文档。

样本数据

本指南中的示例使用 Atlas示例数据集中的sample_restaurants.restaurants集合。要学习；了解如何创建免费的MongoDB Atlas 群集并加载示例数据集，请参阅Atlas入门指南。

此集合中的文档由以下Kotlin数据类建模：

data class Restaurant(
    val name: String,
    val borough: String,
    val cuisine: String,
    val address: Document
)

更新操作

您可以使用以下方法更新MongoDB中的文档：

updateOne()，更新匹配搜索条件的第一个文档
updateMany()，更新与搜索条件匹配的所有文档

每种更新方法都需要以下参数：

查询过滤，用于匹配要更新的文档。要学习；了解有关查询筛选器的更多信息，请参阅《指定查询》指南。
更新文档，指定更新操作符或要执行的更新类型，以及要更新的字段和值。有关更新操作符及其用法的列表，请参阅MongoDB Server手册中的字段更新操作符指南页面。

更新一个文档

以下示例使用updateOne()方法将文档的name值从"Happy Garden"更新为"Mountain House" ：

val filter = eq(Restaurant::name.name, "Happy Garden")
val update = set(Restaurant::name.name, "Mountain House")
val result = collection.updateOne(filter, update)

更新多个文档

以下示例使用updateMany()方法更新name值为"Starbucks"的所有文档。此更新将address字段重命名为location 。

val filter = eq(Restaurant::name.name, "Starbucks")
val update = rename(Restaurant::address.name, "location")
val result = collection.updateMany(filter, update)

自定义更新操作

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`
`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()方法匹配name字段值为"Sunrise Pizzeria"的文档。然后，它将第一个匹配文档中的borough值设置为"Queens" ，并将cuisine值设置为"Italian" 。

由于upsert选项设立为true ，因此如果查询过滤与任何现有文档都不匹配，驾驶员将插入一个具有更新文档中指定的字段和值的新文档。

val opts = UpdateOptions().upsert(true)
val filter = eq(Restaurant::name.name, "Sunrise Pizzeria")
val update = combine(
    set(Restaurant::borough.name, "Queens"),
    set(Restaurant::cuisine.name, "Italian")
)
collection.updateOne(filter, update, opts)

返回值

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异常。如果服务器未确认写入操作，则驾驶员无法确定这些值。