db.collection.replaceOne()

On this page本页内容

Definition定义

db.collection.replaceOne(filter, replacement, options)

mongo Shell Method

This page documents the mongo shell method, and does not refer to the MongoDB Node.js driver (or any other driver) method. 本页记录了mongo shell方法，未提及MongoDB Node.js驱动程序（或任何其他驱动程序）方法。For corresponding MongoDB driver API, refer to your specific MongoDB driver documentation instead.有关相应的MongoDB驱动程序API，请参阅特定的MongoDB驱动程序文档。

New in version 3.2.版本3.2中的新功能。

Replaces a single document within the collection based on the filter.基于筛选器替换集合中的单个文档。

The replaceOne() method has the following form:replaceOne()方法的形式如下：

db.collection.replaceOne(
   <filter>,
   <replacement>,
   {
     upsert: <boolean>,
     writeConcern: <document>,
     collation: <document>,
     hint: <document|string>                   // Available starting in 4.2.1
   }
)

The replaceOne() method takes the following parameters:replaceOne()方法采用以下参数：

Parameter参数Type类型Description描述
filter document

The selection criteria for the update. 更新的选择标准。The same query selectors as in the find() method are available.与find()方法中相同的查询选择器可用。

Specify an empty document { } to replace the first document returned in the collection.指定一个空文档{}，以替换集合中返回的第一个文档。

replacement document

The replacement document.替换文件。

Cannot contain update operators.不能包含更新运算符。

upsert boolean

Optional.可选。When true, replaceOne() either:如果为true，则replaceOne()可以：

  • Inserts the document from the replacement parameter if no document matches the filter.如果没有与filter匹配的文档，则插入replacement参数中的文档。
  • Replaces the document that matches the filter with the replacement document.用replacement文档替换与filter匹配的文档。

MongoDB will add the _id field to the replacement document if it is not specified in either the filter or replacement documents. 如果filter或replacement文档中未指定_id字段，MongoDB将向替换文档中添加该字段。If _id is present in both, the values must be equal.如果两者中都存在_id，则值必须相等。

To avoid multiple upserts, ensure that the query fields are uniquely indexed.要避免多个upsert，请确保query字段的索引是唯一的。

Defaults to false.默认为false。

writeConcern document

Optional.可选。A document expressing the write concern. 表达写入关注点的文档。Omit to use the default write concern.忽略使用默认的写关注点。

Do not explicitly set the write concern for the operation if run in a transaction. 如果在事务中运行，请不要显式设置操作的写入关注点。To use write concern with transactions, see Transactions and Write Concern.要将写关注点用于事务，请参阅事务和写关注点。

collation document

Optional.可选。

Specifies the collation to use for the operation.指定要用于该操作的排序规则。

Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号的规则。

The collation option has the following syntax:collation选项语法如下所示：

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

When specifying collation, the locale field is mandatory; all other collation fields are optional. 指定排序规则时，locale字段是必需的；所有其他排序规则字段都是可选的。For descriptions of the fields, see Collation Document.有关这些字段的描述，请参阅排序规则文档。

If the collation is unspecified but the collection has a default collation (see db.createCollection()), the operation uses the collation specified for the collection.如果未指定排序规则，但集合具有默认排序规则（请参见db.createCollection()），则操作将使用为集合指定的排序规则。

If no collation is specified for the collection or for the operations, MongoDB uses the simple binary comparison used in prior versions for string comparisons.如果没有为集合或操作指定排序规则，MongoDB将使用以前版本中用于字符串比较的简单二进制比较。

You cannot specify multiple collations for an operation. 不能为一个操作指定多个排序规则。For example, you cannot specify different collations per field, or if performing a find with a sort, you cannot use one collation for the find and another for the sort.例如，不能为每个字段指定不同的排序规则，或者如果使用排序执行查找，则不能对查找使用一种排序规则，对排序使用另一种排序规则。

New in version 3.4.版本3.4中的新功能。

hint document

Optional. 可选。A document or string that specifies the index to use to support the filter.指定用于支持筛选器的索引的文档或字符串。

The option can take an index specification document or the index name string.该选项可以采用索引规范文档或索引名称字符串。

If you specify an index that does not exist, the operation errors.如果指定的索引不存在，则操作将出错。

For an example, see Specify hint for replaceOne.有关示例，请参阅为replaceOne指定提示。

New in version 4.2.1.在4.2.1版中新增。

Returns:A document containing:包含以下内容的文件：
  • A boolean acknowledged as true if the operation ran with write concern or false if write concern was disabled如果操作以写关注点运行，则布尔值acknowledged为true；如果写关注点被禁用，则布尔值acknowledged为false
  • matchedCount containing the number of matched documents包含匹配文档的数量
  • modifiedCount containing the number of modified documents包含已修改文档的数量
  • upsertedId containing the _id for the upserted document包含所upserted文档的_id

Behavior行为

replaceOne() replaces the first matching document in the collection that matches the filter, using the replacement document.使用replacement文档替换集合中与filter匹配的第一个匹配文档。

upsert

If upsert: true and no documents match the filter, db.collection.replaceOne() creates a new document based on the replacement document.如果upsert:true且没有与filter匹配的文档，db.collection.replaceOne()将基于替换文档创建一个新文档。

If you specify upsert: true on a sharded collection, you must include the full shard key in the filter. 如果在分片集合上指定upsert:true，则必须在filter中包含完整的分片密钥。For additional db.collection.replaceOne() behavior on a sharded collection, see Sharded Collections.有关切分集合的其他db.collection.replaceOne()行为，请参阅切分集合。

See Replace with Upsert.请参见使用Upsert替换。

Capped Collections封顶集合

If a replacement operation changes the document size, the operation will fail.如果替换操作更改了文档大小，则该操作将失败。

Sharded Collections分片集合

Starting in MongoDB 4.2, db.collection.replaceOne() attempts to target a single shard, first by using the query filter. 从MongoDB 4.2开始，db.collection.replaceOne()首先通过使用查询筛选器，尝试以单个碎片为目标。If the operation cannot target a single shard by the query filter, it then attempts to target by the replacement document.如果操作无法通过查询筛选器以单个碎片为目标，那么它将尝试通过替换文档以该碎片为目标。

In earlier versions, the operation attempts to target using the replacement document.在早期版本中，该操作尝试使用替换文档作为目标。

Shard Key Requirements In Replacement Document替换文档中的切分关键要求

Starting in MongoDB 4.4, the replacement document does not need to include the shard key. 从MongoDB 4.4开始，替换文档不需要包含碎片密钥。In MongoDB 4.2 and earlier, the replacement document must include the shard key.在MongoDB 4.2及更早版本中，替换文档必须包含碎片密钥。

Warning

Starting in version 4.4, documents in sharded collections can be missing the shard key fields. 从4.4版开始，分片集合中的文档可能会缺少分片键字段。Take precaution to avoid accidentally removing the shard key when changing a document’s shard key value.采取预防措施，以避免在更改文档的shard key值时意外删除shard key。

upsert on a Sharded Collection在分片集合上upsert

Starting in MongoDB 4.2, a db.collection.replaceOne() operation that includes upsert: true on a sharded collection must include the full shard key in the filter.从MongoDB 4.2开始，在分片集合上包含upsert:true的db.collection.replaceOne()操作必须在筛选器中包含完整的分片键。

However, starting in version 4.4, documents in a sharded collection can be missing the shard key fields. 但是，从4.4版开始，分片集合中的文档可能会缺少分片键字段。To target a document that is missing the shard key, you can use the null equality match in conjunction with another filter condition (such as on the _id field). 要将缺少切分键的文档作为目标，可以将null相等匹配与另一个筛选条件结合使用（例如在_id字段上）。For example:例如：

{ _id: <value>, <shardkeyfield>: null } // _id of the document missing shard key

Shard Key Modification分片键修改

Starting in MongoDB 4.2, you can update a document’s shard key value unless the shard key field is the immutable _id field. 从MongoDB 4.2开始，可以更新文档的shard key值，除非分片键字段是不可变的_id字段。Before MongoDB 4.2, a document’s shard key field value is immutable.在MongoDB 4.2之前，文档的分片键字段值是不可变的。

Warning警告

Starting in version 4.4, documents in sharded collections can be missing the shard key fields. 从4.4版开始，分片集合中的文档可能会缺少分片键字段。Take precaution to avoid accidentally removing the shard key when changing a document’s shard key value.采取预防措施，以避免在更改文档的分片键值时意外删除分片键。

To modify the existing shard key value with db.collection.replaceOne():要使用db.collection.replaceOne()修改现有的碎片键值，请执行以下操作：

  • You must run on a mongos. 你必须在mongos上运行。Do not issue the operation directly on the shard.不要直接在分片上发布操作。
  • You must run either in a transaction or as a retryable write.您必须在事务中运行，或作为可重试写入运行。
  • You must include an equality filter on the full shard key.必须在完整分片键上包含相等筛选器。

Missing Shard Key缺失分片键

Starting in version 4.4, documents in a sharded collection can be missing the shard key fields. 从4.4版开始，切分集合中的文档可能会缺少分片键字段。To use db.collection.replaceOne() to set the document’s missing shard key, you must run on a mongos. 要使用db.collection.replaceOne()设置文档缺少的分片键，必须在mongos上运行。Do not issue the operation directly on the shard.不要直接在分片上发布操作。

In addition, the following requirements also apply:此外，以下要求也适用：

 Requirements
To set to null
  • Requires equality filter on the full shard key if upsert: true is specified.如果指定了upsert:true，则需要对完整分片键进行相等筛选。
To set to a non-null value设置为非null值
  • Must be performed either inside a transaction or as a retryable write.
  • Requires equality filter on the full shard key if either:如果出现以下情况之一，则需要对完整分片键进行相等筛选：
    • upsert: true, or
    • the new shard key value belongs to a different shard.新的分片键值属于不同的分片。

Tip

Since a missing key value is returned as part of a null equality match, to avoid updating a null-valued key, include additional query conditions (such as on the _id field) as appropriate.由于缺少的键值是作为空相等匹配的一部分返回的，为了避免更新空值键值，请酌情包括其他查询条件（例如在_id字段上）。

See also:

Transactions事务

db.collection.replaceOne() can be used inside multi-document transactions.可以在多文档事务中使用。

Important

In most cases, multi-document transaction incurs a greater performance cost over single document writes, and the availability of multi-document transactions should not be a replacement for effective schema design. 在大多数情况下，与单文档写入相比，多文档事务会带来更大的性能成本，而多文档事务的可用性不应取代有效的模式设计。For many scenarios, the denormalized data model (embedded documents and arrays) will continue to be optimal for your data and use cases. 对于许多场景，非规范化数据模型（嵌入式文档和数组）将继续适合您的数据和用例。That is, for many scenarios, modeling your data appropriately will minimize the need for multi-document transactions.也就是说，对于许多场景，适当地建模数据将最大限度地减少对多文档事务的需求。

For additional transactions usage considerations (such as runtime limit and oplog size limit), see also Production Considerations.有关其他事务使用注意事项（如运行时限制和oplog大小限制），请参阅生产注意事项。

Upsert within Transactions在事务中Upsert

Starting in MongoDB 4.4 with feature compatibility version (fcv) "4.4", you can create collections and indexes inside a multi-document transaction if the transaction is not a cross-shard write transaction.从功能兼容版本（fcv）"4.4"的MongoDB 4.4开始，如果事务不是跨分片写入事务，则可以在多文档事务中创建集合和索引。

As such, for the feature compatibility version (fcv) is "4.4" or greater, db.collection.replaceOne() with upsert: true can be run against an existing collection or a non-existing collection. 因此，对于功能兼容性版本（fcv）为"4.4"或更高版本的情况，可以对现有集合或不存在的集合运行带有upsert:true的db.collection.replaceOne()。If run against a non-existing collection, the operation creates the collection.如果针对不存在的集合运行，该操作将创建该集合。

If the feature compatibility version (fcv) is "4.2" or less, the operation must be against an existing collection.如果 功能兼容版本（fcv）为“4.2”或更低，则操作必须针对现有集合。

See also参阅

Create Collections and Indexes In a Transaction在事务中创建集合和索引

Write Concerns and Transactions写入关注点和事务

Do not explicitly set the write concern for the operation if run in a transaction. 如果在事务中运行，请不要显式设置操作的写入关注点。To use write concern with transactions, see Transactions and Write Concern.要将写关注点用于事务，请参阅事务和写关注点。

Examples示例

Replace代替

The restaurant collection contains the following documents:restaurant集合包含以下文档：

{ "_id" : 1, "name" : "Central Perk Cafe", "Borough" : "Manhattan" },
{ "_id" : 2, "name" : "Rock A Feller Bar and Grill", "Borough" : "Queens", "violations" : 2 },
{ "_id" : 3, "name" : "Empire State Pub", "Borough" : "Brooklyn", "violations" : 0 }

The following operation replaces a single document where name: "Central Perk Cafe":以下操作将替换名为name: "Central Perk Cafe"的单个文档：

try {
   db.restaurant.replaceOne(
      { "name" : "Central Perk Cafe" },
      { "name" : "Central Pork Cafe", "Borough" : "Manhattan" }
   );
} catch (e){
   print(e);
}

The operation returns:操作返回：

{ "acknowledged" : true, "matchedCount" : 1, "modifiedCount" : 1 }

If no matches were found, the operation instead returns:如果未找到匹配项，则操作将返回：

{ "acknowledged" : true, "matchedCount" : 0, "modifiedCount" : 0 }

Setting upsert: true would insert the document if no match was found. 如果未找到匹配项，则设置upsert:true将插入文档。See Replace with Upsert请参见替换为Upsert

Replace with Upsert使用Upsert替换

The restaurant collection contains the following documents:restaurant集合包含以下文档：

{ "_id" : 1, "name" : "Central Perk Cafe", "Borough" : "Manhattan",  "violations" : 3 },
{ "_id" : 2, "name" : "Rock A Feller Bar and Grill", "Borough" : "Queens", "violations" : 2 },
{ "_id" : 3, "name" : "Empire State Pub", "Borough" : "Brooklyn", "violations" : 0 }

The following operation attempts to replace the document with name : "Pizza Rat's Pizzaria", with upsert : true:以下操作尝试将文档替换为name : "Pizza Rat's Pizzaria"，使用upsert:true：

try {
   db.restaurant.replaceOne(
      { "name" : "Pizza Rat's Pizzaria" },
      { "_id": 4, "name" : "Pizza Rat's Pizzaria", "Borough" : "Manhattan", "violations" : 8 },
      { upsert: true }
   );
} catch (e){
   print(e);
}

Since upsert : true the document is inserted based on the replacement document. 因为upsert:true，所以根据replacement文档插入文档。The operation returns:操作返回：

{
   "acknowledged" : true,
   "matchedCount" : 0,
   "modifiedCount" : 0,
   "upsertedId" : 4
}

The collection now contains the following documents:该集合现在包含以下文档：

{ "_id" : 1, "name" : "Central Perk Cafe", "Borough" : "Manhattan", "violations" : 3 },
{ "_id" : 2, "name" : "Rock A Feller Bar and Grill", "Borough" : "Queens", "violations" : 2 },
{ "_id" : 3, "name" : "Empire State Pub", "Borough" : "Brooklyn", "violations" : 0 },
{ "_id" : 4, "name" : "Pizza Rat's Pizzaria", "Borough" : "Manhattan", "violations" : 8 }

Replace with Write Concern替换为写关注点

Given a three member replica set, the following operation specifies a w of majority and wtimeout of 100:给定一个由三个成员组成的副本集，以下操作指定w为majority，wtimeout为100：

try {
   db.restaurant.replaceOne(
       { "name" : "Pizza Rat's Pizzaria" },
       { "name" : "Pizza Rat's Pub", "Borough" : "Manhattan", "violations" : 3 },
       { w: "majority", wtimeout: 100 }
   );
} catch (e) {
   print(e);
}

If the acknowledgement takes longer than the wtimeout limit, the following exception is thrown:如果确认时间超过wtimeout限制，则会引发以下异常：

Changed in version 4.4.在版本4.4中更改。

WriteConcernError({
   "code" : 64,
   "errmsg" : "waiting for replication timed out",
   "errInfo" : {
     "wtimeout" : true,
     "writeConcern" : {
       "w" : "majority",
       "wtimeout" : 100,
       "provenance" : "getLastErrorDefaults"
     }
   }
})

The following table explains the possible values of errInfo.writeConcern.provenance:下表说明了errInfo.writeConcern.provenance的可能值：

ProvenanceDescription描述
clientSupplied The write concern was specified in the application.应用程序中指定了写入关注点。
customDefault The write concern originated from a custom defined default value. 写入关注点源于自定义的默认值。See setDefaultRWConcern.请参阅setDefaultRWConcern。
getLastErrorDefaults The write concern originated from the replica set’s settings.getLastErrorDefaults field.写入关注点源自复制集的settings.getLastErrorDefaults字段。
implicitDefault The write concern originated from the server in absence of all other write concern specifications.在没有所有其他写关注规范的情况下，写关注源于服务器。

Specify Collation指定排序规则

New in version 3.4.版本3.4中的新功能。

Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号的规则。

A collection myColl has the following documents:myColl集合包含以下文档：

{ _id: 1, category: "café", status: "A" }
{ _id: 2, category: "cafe", status: "a" }
{ _id: 3, category: "cafE", status: "a" }

The following operation includes the collation option:以下操作包括collation选项：

db.myColl.replaceOne(
   { category: "cafe", status: "a" },
   { category: "cafÉ", status: "Replaced" },
   { collation: { locale: "fr", strength: 1 } }

);

Specify hint for replaceOne为replaceOne指定hint

New in version 4.2.1.在4.2.1版中新增。

Create a sample members collection with the following documents:使用以下文档创建示例members集合：

db.members.insertMany([
   { "_id" : 1, "member" : "abc123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 2, "member" : "xyz123", "status" : "A", "points" : 60,  "misc1" : "reminder: ping me at 100pts", "misc2" : "Some random comment" },
   { "_id" : 3, "member" : "lmn123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 4, "member" : "pqr123", "status" : "D", "points" : 20,  "misc1" : "Deactivated", "misc2" : null },
   { "_id" : 5, "member" : "ijk123", "status" : "P", "points" :  0,  "misc1" : null, "misc2" : null },
   { "_id" : 6, "member" : "cde123", "status" : "A", "points" : 86,  "misc1" : "reminder: ping me at 100pts", "misc2" : "Some random comment" }
])

Create the following indexes on the collection:在集合上创建以下索引：

db.members.createIndex( { status: 1 } )
db.members.createIndex( { points: 1 } )

The following update operation explicitly hints to use the index {status: 1 }:以下更新操作明确提示使用索引{status:1}：

Note

If you specify an index that does not exist, the operation errors.如果指定的索引不存在，则操作将出错。

db.members.replaceOne(
   { "points": { $lte: 20 }, "status": "P" },
   { "misc1": "using index on status", status: "P", member: "replacement", points: "20"},
   { hint: { status: 1 } }
)

The operation returns the following:该操作返回以下内容：

{ "acknowledged" : true, "matchedCount" : 1, "modifiedCount" : 1 }

To view the indexes used, you can use the $indexStats pipeline:要查看使用的索引，可以使用$indexStats管道：

db.members.aggregate( [ { $indexStats: { } }, { $sort: { name: 1 } } ] )