/ /

替换文档

Overview

在本指南中，您可以学习如何使用Kotlin Sync驱动程序对MongoDB集合中的文档执行替换操作。替换操作会删除指定文档中除 _id字段之外的所有字段和值，并添加您指定的新字段和值。此操作与更新操作不同，后者仅更改一个或多个文档中的指定字段。

要学习；了解有关更新操作的更多信息，请参阅更新文档指南。

样本数据

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

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

data class Restaurant(
    val name: String,
    val borough: String,
    val cuisine: String,
    val owner: String?,
)

替换操作

您可以使用replaceOne()方法在MongoDB中执行替换操作。此方法会从与查询过滤匹配的第一个文档中删除除_id字段之外的所有字段。然后，它将您指定的字段和值添加到空文档中。

所需参数

您必须将以下参数传递给replaceOne()方法：

查询过滤，用于匹配要更新的文档。如需学习；了解有关查询筛选器的更多信息，请参阅“指定查询”指南。
替换文档，指定要替换现有字段和值的字段和值。

替换一个文档

以下示例使用replaceOne()方法替换name字段值为"Primola Restaurant"的文档的字段和值：

val filter = Filters.eq(Restaurant::name.name, "Primola Restaurant")
val replacement = Restaurant(
    "Frutti Di Mare",
    "Queens",
    "Seafood",
    owner = "Sal Thomas"
)
val result = collection.replaceOne(filter, replacement)

重要

_id 字段的值不可变。如果替换文档为 _id字段指定了值，则该值必须与现有文档的 _id 值相同，否则驱动程序将引发 WriteError。

自定义替换操作

replaceOne() 方法可以选择接受一个参数，该参数设置用于配置替换操作的选项。如果不指定任何选项，驱动程序将使用默认设置执行替换操作。

下表描述了可用于配置ReplaceOptions实例的 setter 方法：

属性	说明
`upsert()`	指定在没有文档与查询过滤匹配的情况下，替换操作是否执行更新或插入（upsert）操作。有关更多信息，请参阅MongoDB Server手册中的更新或插入（upsert）行为。默认为 `false`
`sort(Bson sort)`	设置要应用操作的排序条件。如果多个文档与您传递给 `replaceOne()` 方法的查询过滤匹配，则该操作将替换第一个结果。您可以设立此选项以对匹配的文档应用顺序，以便更好地控制替换哪个文档。
`bypassDocumentValidation()`	指定更新操作是否绕过文档验证。这样，您就可以更新不符合模式验证要求的文档（如果存在）。有关模式验证的更多信息，请参阅MongoDB Server手册中的模式验证。默认为 `false`。
`collation()`	指定对结果进行排序时要使用的语言排序规则类型。有关更多信息，请参阅 MongoDB Server 手册中的排序规则。
`hint()`	设置匹配文档时使用的索引。有关更多信息，请参阅MongoDB Server手册中的提示声明。
`let()`	提供参数名称和值的映射，以便为操作设立顶级变量。值必须是常量或不引用文档字段的闭合表达式。
`comment()`	设置要附加到操作的注释。

以下代码将 upsert 选项设置为 true，这会指示驱动程序在查询筛选条件与任何现有文档都不匹配时插入具有替换文档中指定的字段和值的新文档：

val opts = ReplaceOptions().upsert(true)
val result = collection.replaceOne(filter, replacement, opts)

返回值

replaceOne()方法返回一个UpdateResult对象。您可以使用以下方法访问权限UpdateResult实例中的信息：

属性	说明
`getMatchedCount()`	无论执行了多少次更新，都返回与查询过滤匹配的文档数。
`getModifiedCount()`	返回更新操作修改的文档数。如果更新后的文档与原始文档相同，则不计入此计数。
`wasAcknowledged()`	如果服务器确认结果，则返回 `true`。
`getUpsertedId()`	如果驱动程序执行了更新或插入，则返回在数据库中更新或插入的文档的 `_id` 值。