/ /

/ /

替换文档

Overview

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

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

样本数据

本指南中的示例使用Atlas示例数据集的 sample_restaurants数据库中的 restaurants集合。要从Ruby应用程序访问权限此集合，请创建一个连接到Atlas 集群的Mongo::Client对象，并将以下值分配给 database 和 collection 变量：

database = client.use('sample_restaurants')
collection = database[:restaurants]

要学习如何创建免费的MongoDB Atlas 集群并加载示例数据集，请参阅MongoDB 入门指南。

替换操作

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

所需参数

您必须将以下参数传递给replace_one方法：

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

替换示例

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

filter = { name: 'Primola Restaurant' }
new_document = { name: 'Frutti Di Mare', cuisine: 'Seafood', borough: 'Queens' }
result = collection.replace_one(filter, new_document)
puts "Replaced #{result.modified_count} document(s)"

Replaced 1 document(s)

重要

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

自定义替换操作

您可以将 Hash对象作为参数传递给 replace_one 方法，以设立配置替换操作的选项。如果不指定任何选项，驱动程序将使用默认设置执行替换操作。

下表描述了可用于配置替换操作的选项：

选项	说明
`upsert`	指定在没有文档与查询过滤匹配的情况下，替换操作是否执行更新或插入（upsert）操作。有关更多信息，请参阅MongoDB Server手册中的更新或插入（upsert）行为。默认为 `false`。
`bypass_document_validation`	指定更新操作是否绕过文档验证。这样，您就可以更新不符合模式验证要求的文档（如果存在）。有关模式验证的更多信息，请参阅MongoDB Server手册中的模式验证。默认为 `false`。
`collation`	指定对结果进行排序时要使用的语言排序规则类型。有关更多信息，请参阅 MongoDB Server 手册中的排序规则。
`session`	指定用于操作的会话。要学习；了解有关会话的更多信息，请参阅MongoDB Server手册中的客户端会话和因果一致性保证。
`hint`	设置匹配文档时使用的索引。有关更多信息，请参阅MongoDB Server手册中的提示声明。
`let`	提供参数名称和值的映射，以便为操作设立顶级变量。值必须是常量或不引用文档字段的闭合表达式。

以下代码执行与前面的示例相同的替换操作，但将 upsert 选项设置为 true。如果查询筛选条件与任何现有文档都不匹配，则这会指示驱动程序插入具有替换文档中指定的字段和值的新文档：

options = { upsert: true }
result = collection.replace_one(filter, new_document, options)
puts "Replaced #{result.upserted_count} document(s)"

Replaced 1 document(s)

返回值

replace_one 方法返回一个 Mongo::Operation::Update::Result对象。您可以使用以下方法访问权限Result实例中的信息：

方法	说明
`matched_count`	返回与查询过滤匹配的文档数。
`modified_count`	返回更新操作修改的文档数。如果更新后的文档与原始文档相同，则不计入此计数。
`upserted_count`	返回已更新或插入的文档数。
`upserted_id`	返回驾驶员更新或插入到数据库中的文档的 `_id` 值（如果有）。

替换文档

Overview

样本数据

替换操作

所需参数

替换示例

重要

自定义替换操作

返回值

更多信息

API 文档