Docs Home → MongoDB Manual

db.collection.findOneAndReplace()

On this page本页内容

Definition定义

db.collection.findOneAndReplace( filter, replacement, options )
Important

mongosh Method

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

For the database command, see the update command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

mongo shell v4.4

Replaces a single document based on the specified filter.基于指定的filter替换单个文档。

Syntax语法

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

db.collection.findOneAndReplace(
   <filter>,
   <replacement>,
   {
     writeConcern: <document>,
     projection: <document>,
     sort: <document>,
     maxTimeMS: <number>,
     upsert: <boolean>,
     returnDocument: <string>,
     returnNewDocument: <boolean>,
     collation: <document>
   }
)

Fields and Options字段和选项

The findOneAndReplace() method takes the following fields and options:findOneAndReplace()方法采用以下字段和选项：

Field字段Type类型Description描述
filterdocumentThe selection criteria for the update. 更新的选择条件。The same query selectors as in the find() method are available.可以使用与find()方法中相同的查询选择器。
To replace the first document returned in the collection, specify an empty document { }.若要替换集合中返回的第一个文档，请指定一个空文档{ }。
If unspecified, defaults to an empty document.如果未指定，则默认为空文档。
Starting in MongoDB 4.2, the operation returns an error if the query argument is not a document. 从MongoDB 4.2开始，如果查询参数不是文档，则该操作将返回错误。
replacementdocumentThe replacement document.替换文档。
Cannot contain update operators.不能包含更新运算符。
The <replacement> document cannot specify an _id value that differs from the replaced document. <replacement>文档不能指定与被替换文档不同的_id值。
writeConcerndocumentOptional.可选的。A document expressing the write concern. Omit to use the default write concern. 表示写入关注的文档。忽略使用默认的写入关注。
{ w: <value>, j: <boolean>, wtimeout: <number> }
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. 要在事务中使用写入关注，请参阅事务和写入关注。
projectiondocumentOptional.可选的。A subset of fields to return.要返回的字段的子集。
To return all fields in the matching document, omit this field.若要返回匹配文档中的所有字段，请省略此字段。
Starting in MongoDB 4.2, the operation returns an error if the projection field is not a document. 从MongoDB 4.2开始，如果投影字段不是文档，则操作会返回错误。
sortdocumentOptional.可选的。Specifies a sorting order for the documents matched by the filter.为filter匹配的文档指定排序顺序。
Starting in MongoDB 4.2, the operation returns an error if the sort field is not a document.从MongoDB 4.2开始，如果排序字段不是文档，该操作将返回一个错误。
See cursor.sort(). 请参阅cursor.sort()。
maxTimeMSnumberOptional.可选的。Specifies a time limit in milliseconds within which the operation must complete. Returns an error if the limit is exceeded.指定操作必须完成的时间限制（以毫秒为单位）。如果超过限制，则返回错误。
upsertbooleanOptional.可选的。When true, findOneAndReplace() either: 如果为true，则findOneAndReplace()进行以下操作：
  • Inserts the document from the replacement parameter if no document matches the filter. 如果没有与filter匹配的文档，则插入replacement参数中的文档。Returns null after inserting the new document, unless returnNewDocument is true.插入新文档后返回null，除非returnNewDocument为true。
  • 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. If _id is present in both, the values must be equal.如果filter或replacement中都没有指定_id字段，MongoDB会将其添加到替换文档中。如果两者中都存在_id，则值必须相等。
To avoid multiple upserts, ensure that the query fields are uniquely indexed.为了避免多个upsert，请确保query字段是唯一索引的。
Defaults to false. 默认值为false。
returnDocumentstringOptional.可选的。Starting in mongosh 0.13.2, returnDocument is an alternative for returnNewDocument. If both options are set, returnDocument takes precedence.从mongosh 0.13.2开始，returnDocument是returnNewDocument的替代方案。如果同时设置了这两个选项，则returnDocument优先。
returnDocument: "before" returns the original document. 返回原始文档。returnDocument: "after" returns the updated document. 返回更新后的文档。
returnNewDocumentbooleanOptional.可选的。When true, returns the replacement document instead of the original document.如果为true，则返回替换文档而不是原始文档。
Defaults to false. 默认为false。
collationdocumentOptional.可选的。
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. 例如，不能为每个字段指定不同的排序规则，或者如果使用排序执行查找，则不能为查找使用一个排序规则，为排序使用另一个排序顺序。

Returns返回

Returns the original document by default. Returns the updated document if returnDocument is set to after or returnNewDocument is set to true.默认情况下返回原始文档。如果returnDocument设置为after或returnNewDocument设置为true，则返回更新的文档。

Behavior行为

Document Match文档匹配

db.collection.findOneAndReplace() replaces the first matching document in the collection that matches the filter. 替换集合中与filter匹配的第一个匹配文档。The sort field can be used to influence which document is modified.sort字段可用于影响修改的文档。

Projection投影

Important

Language Consistency语言一致性

Starting in MongoDB 4.4, as part of making find() and findAndModify() projection consistent with aggregation's $project stage,从MongoDB 4.4开始，作为使find()和findAndModify()投影与聚合的$project阶段一致的一部分，

The projection field takes a document in the following form:projection字段采用以下形式的文档：

{ field1: <value>, field2: <value> ... }
Projection投影Description描述
<field>: <1 or true>Specifies the inclusion of a field. 指定包含字段。If you specify a non-zero integer for the projection value, the operation treats the value as true.如果为投影值指定非零整数，则操作会将该值视为true。
<field>: <0 or false>Specifies the exclusion of a field.指定字段的排除。
"<field>.$": <1 or true>Uses the $ array projection operator to return the first element that matches the query condition on the array field. 使用$数组投影运算符返回与数组字段上的查询条件匹配的第一个元素。If you specify a non-zero integer for the projection value, the operation treats the value as true.如果为投影值指定非零整数，则操作会将该值视为true。
Not available for views. 不可用于视图。
<field>: <array projection>Uses the array projection operators ($elemMatch, $slice) to specify the array elements to include.使用数组投影运算符（$elemMatch，$slice）指定要包含的数组元素。
Not available for views. 不可用于视图。
<field>: <aggregation expression>Specifies the value of the projected field.指定投影字段的值。
Starting in MongoDB 4.4, with the use of aggregation expressions and syntax, including the use of literals and aggregation variables, you can project new fields or project existing fields with new values. 从MongoDB 4.4开始，通过使用聚合表达式和语法，包括使用文字和聚合变量，您可以投影新字段或使用新值投影现有字段。
  • If you specify a non-numeric, non-boolean literal (such as a literal string or an array or an operator expression) for the projection value, the field is projected with the new value, for example: 如果为投影值指定非数字、非布尔文字（如文字字符串、数组或运算符表达式），则字段将使用新值进行投影，例如：
    • { field: [ 1, 2, 3, "$someExistingField" ] }
    • { field: "New String Value" }
    • { field: { status: "Active", total: { $sum: "$existingArray" } } }
  • To project a literal value for a field, use the $literal aggregation expression, for example: 要为字段投影文字值，请使用$literal聚合表达式，例如：
    • { field: { $literal: 5 } }
    • { field: { $literal: true } }
    • { field: { $literal: { fieldWithValue0: 0, fieldWithValue1: 1 } } }
In versions 4.2 and earlier, any specification value (with the exception of the previously unsupported document value) is treated as either true or false to indicate the inclusion or exclusion of the field. 在版本4.2及更早版本中，任何规范值（以前不支持的文档值除外）都被视为true或false，以指示包含或排除字段。
New in version 4.4. 4.4版新增。

Embedded Field Specification嵌入式字段规范

For fields in an embedded documents, you can specify the field using either:对于嵌入文档中的字段，可以使用以下任一项指定字段：

  • dot notation, for example "field.nestedfield": <value>点表示法，例如"field.nestedfield": <value>
  • nested form, for example { field: { nestedfield: <value> } } (Starting in MongoDB 4.4)嵌套形式，例如{ field: { nestedfield: <value> } }（从MongoDB 4.4开始）

_id Field Projection字段投影

The _id field is included in the returned documents by default unless you explicitly specify _id: 0 in the projection to suppress the field._id字段默认包含在返回的文档中，除非您在投影中明确指定_id:0以取消显示该字段。

Inclusion or Exclusion包含或排除

A projection cannot contain both include and exclude specifications, with the exception of the _id field:projection不能同时包含include和exclude规范，_id字段除外：

  • In projections that explicitly include fields, the _id field is the only field that you can explicitly exclude.在显式包含字段的投影中，_id字段是唯一可以显式排除的字段。
  • In projections that explicitly excludes fields, the _id field is the only field that you can explicitly include; however, the _id field is included by default.在显式排除字段的投影中，_id字段是唯一可以显式包含的字段；但是，_id字段在默认情况下是包含在内的。

For more information on projection, see also:有关投影的更多信息，另请参见：

Sharded Collections分片集合

To use db.collection.findOneAndReplace() on a sharded collection, the query filter must include an equality condition on the shard key.要在分片集合上使用db.collection.findOneAndReplace()，查询筛选器必须在分片键上包含一个相等条件。

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开始，您可以更新文档的分片-key值，除非分片键字段是不可变的_id字段。In MongoDB 4.2 and earlier, 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. Take precaution to avoid accidentally removing the shard key when changing a document's shard key value.从4.4版本开始，分片集合中的文档可能会缺少分片键字段。请采取预防措施，避免在更改文档的分片键值时意外删除分片键。

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

  • 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.findOneAndReplace() to set the document's missing shard key,要使用db.collection.findOneAndReplace()设置文档缺少的分片键，

  • 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 if the new shard key value is not null.如果新的分片键值不为null，则必须在事务中运行或作为可重试写入运行。
  • You must include an equality filter on the full shard key.必须在完整分片键上包含一个相等筛选器。
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.由于丢失的键值是作为null相等匹配的一部分返回的，为了避免更新null值的键，请酌情包括额外的查询条件（例如在_id字段上）。

See also:另请参阅：

Transactions事务

db.collection.findOneAndReplace() 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.有关其他事务使用注意事项（如运行时限制和操作日志大小限制），请参阅生产注意事项。

Upsert within Transactions事务中的Upsert

Starting in MongoDB 4.4, you can create collections and indexes inside a multi-document transaction if the transaction is not a cross-shard write transaction.从MongoDB 4.4开始，如果多文档事务不是跨分片写入事务，则可以在该事务内创建集合和索引。

Specifically, in MongoDB 4.4 and greater, db.collection.findOneAndReplace() with upsert: true can be run on an existing collection or a non-existing collection. 具体来说，在MongoDB 4.4及更高版本中，具有upsert:true的db.collection.findOneAndReplace()可以在现有集合或不存在的集合上运行。If run on a non-existing collection, the operation creates the collection.如果在不存在的集合上运行，则该操作将创建该集合。

In MongoDB 4.2 and earlier, the operation must be run on an existing collection.在MongoDB 4.2及更早版本中，操作必须在现有集合上运行。

Tip

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 A Document替换文档

Create a sample scores collection with the following documents:使用以下文档创建一个scores样本集合：

db.scores.insertMany([
   { "_id" : 1, "team" : "Fearful Mallards", "score" : 25000 },
   { "_id" : 2, "team" : "Tactful Mooses", "score" : 23500 },
   { "_id" : 3, "team" : "Aquatic Ponies", "score" : 19250 },
   { "_id" : 4, "team" : "Cuddly Zebras", "score" : 15235 },
   { "_id" : 5, "team" : "Garrulous Bears", "score" : 18000 }
]);

The following operation finds a document with score less than 20000 and replaces it:以下操作将查找score低于20000的文档并将其替换：

db.scores.findOneAndReplace(
   { "score" : { $lt : 20000 } },
   { "team" : "Observant Badgers", "score" : 20000 }
)

The operation returns the original document that has been replaced:该操作返回已被替换的原始文档：

{ "_id" : 3, "team" : "Aquatic Ponies", "score" : 19250 }

If returnNewDocument was true, the operation would return the replacement document instead.如果returnNewDocument为true，则操作将返回替换文档。

Although multiple documents meet the filter criteria, db.collection.findOneAndReplace() replaces only one document.尽管有多个文档符合筛选条件，但db.collection.findOneAndReplace()只替换一个文档。

Sort and Replace A Document排序和替换文档

Create a sample scores collection with the following documents:使用以下文档创建一个scores样本集合：

db.scores.insertMany([
   { "_id" : 1, "team" : "Fearful Mallards", "score" : 25000 },
   { "_id" : 2, "team" : "Tactful Mooses", "score" : 23500 },
   { "_id" : 3, "team" : "Aquatic Ponies", "score" : 19250 },
   { "_id" : 4, "team" : "Cuddly Zebras", "score" : 15235 },
   { "_id" : 5, "team" : "Garrulous Bears", "score" : 18000 }
]);

By including an ascending sort on the score field, the following example replaces the document with the lowest score among those documents that match the filter:通过在score字段上包含升序，以下示例将替换与filter匹配的文档中分数最低的文档：

db.scores.findOneAndReplace(
   { "score" : { $lt : 20000 } },
   { "team" : "Observant Badgers", "score" : 20000 },
   { sort: { "score" : 1 } }
)

The operation returns the original document that has been replaced:该操作返回已被替换的原始文档：

{ "_id" : 4, "team" : "Cuddly Zebras", "score" : 15235 }

See Replace A Document for the non-sorted result of this command.有关此命令的未排序结果，请参阅替换文档。

Project Specific Fields in Return Document退货单中的项目特定字段

Create a sample scores collection with the following documents:使用以下文档创建一个scores样本集合：

db.scores.insertMany([
   { "_id" : 1, "team" : "Fearful Mallards", "score" : 25000 },
   { "_id" : 2, "team" : "Tactful Mooses", "score" : 23500 },
   { "_id" : 3, "team" : "Aquatic Ponies", "score" : 19250 },
   { "_id" : 4, "team" : "Cuddly Zebras", "score" : 15235 },
   { "_id" : 5, "team" : "Garrulous Bears", "score" : 18000 }
])

The following operation uses projection to only display the team field in the returned document:以下操作使用projection仅显示返回文档中的team字段：

db.scores.findOneAndReplace(
   { "score" : { $lt : 22250 } },
   { "team" : "Therapeutic Hamsters", "score" : 22250 },
   { sort : { "score" : 1 }, projection: { "_id" : 0, "team" : 1 } }
)

The operation returns the original document with only the team field:该操作返回的原始文档仅包含team字段：

{ "team" : "Cuddly Zebras" }

Replace Document with Time Limit用时间限制替换文档

The following operation sets a 5ms time limit to complete:以下操作设置了5毫秒的时间限制以完成：

try {
   db.scores.findOneAndReplace(
      { "score" : { $gt : 25000 } },
      { "team" : "Emphatic Rhinos", "score" : 25010 },
      { maxTimeMS: 5 }
   );
} catch(e){
   print(e);
}

If the operation exceeds the time limit, it returns:如果操作超过时间限制，则返回：

Error: findAndModifyFailed failed: { "ok" : 0, "errmsg" : "operation exceeded time limit", "code" : 50 }

Replace Document with Upsert用Upsert替换文档

The following operation uses the upsert field to insert the replacement document if no document matches the filter:如果没有与filter匹配的文档，则以下操作使用upsert字段插入替换文档：

try {
   db.scores.findOneAndReplace(
      { "team" : "Fortified Lobsters" },
      { "_id" : 6019, "team" : "Fortified Lobsters" , "score" : 32000},
      { upsert : true, returnDocument: "after" }
   );
} catch (e){
   print(e);
}

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

{
   "_id" : 6019,
   "team" : "Fortified Lobsters",
   "score" : 32000
}

If returnDocument: "before" was set, the operation would return null because there is no original document to return.如果设置了returnDocument: "before"，则操作将返回null，因为没有要返回的原始文档。

Specify Collation指定排序规则

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

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

db.myColl.insertMany([
   { _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.findOneAndReplace(
   { category: "cafe", status: "a" },
   { category: "cafÉ", status: "Replaced" },
   { collation: { locale: "fr", strength: 1 } }
);

The operation returns the following document:该操作返回以下文档：

{ "_id" : 1, "category" : "café", "status" : "A" }