$replaceOne (aggregation)

On this page本页内容

Definition定义

$replaceOne

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

Replaces the first instance of a search string in an input string with a replacement string.用替换字符串替换输入字符串中搜索字符串的第一个实例。

If no occurrences are found, $replaceOne evaluates to the input string.如果未找到匹配项,$replaceOne将计算为输入字符串。

$replaceOne is both case-sensitive and diacritic-sensitive, and ignores any collation present on a collection.区分大小写,区分重音,并忽略集合中存在的任何排序规则。

Syntax语法

The $replaceOne operator has the following operator expression syntax:$replaceOne运算符具有以下运算符表达式语法

{ $replaceOne: { input: <expression>, find: <expression>, replacement: <expression> } }

Operator Fields运算符字段

Field字段Description描述
input

The string on which you wish to apply the find. 要对其应用find的字符串。Can be any valid expression that resolves to a string or a null. 可以是解析为字符串或null的任何有效表达式If input refers to a field that is missing, $replaceOne returns null.如果input引用的字段丢失,$replaceOne将返回null

find

The string to search for within the given input. 要在给定input中搜索的字符串。Can be any valid expression that resolves to a string or a null. 可以是解析为字符串或null的任何有效表达式If find refers to a field that is missing, $replaceOne returns null.如果find引用的字段丢失,$replaceOne将返回null

replacement

The string to use to replace the first matched instance of find in input. 用于替换input中第一个匹配的find实例的字符串。Can be any valid expression that resolves to a string or a null.可以是解析为字符串或null的任何有效表达式

Behavior行为

If no occurrences of find are found in input, $replaceOne evaluates to the input string.如果在输入中未找到find,则$replaceOne将计算为输入字符串。

The input, find, and replacement expressions must evaluate to a string or a null, or $replaceOne fails with an error.inputfindreplacement表达式的计算结果必须为字符串或null,否则$replaceOne失败并出现错误。

$replaceOne and Null ValuesNull

If input or find refer to a field that is missing, they return null.如果inputfind引用的字段缺失,则返回null

If any one of input, find, or replacement evaluates to a null, the entire $replaceOne expression evaluates to null:如果inputfindreplacement中的任何一个计算结果为null,则整个$replaceOne表达式的计算结果为null

Example示例Result
{ $replaceOne: { input: null, find: "abc", replacement: "ABC" } } null
{ $replaceOne: { input: "abc", find: null, replacement: "ABC" } } null
{ $replaceOne: { input: "abc", find: "abc", replacement: null } } null

$replaceOne and Collation和排序规则

String matching for all $replaceOne expressions is always case-sensitive and diacritic-sensitive. 所有$replaceOne表达式的字符串匹配始终区分大小写,区分重音。Any collation configured is ignored when performing string comparisons with $replaceOne.在与$replaceOne进行字符串比较时,将忽略配置的任何排序规则

For example, create a sample collection with collation strength 1:例如,创建排序规则强度为1的样本集合:

db.createCollection( "myColl", { collation: { locale: "fr", strength: 1 } } )

A collation strength of 1 compares base character only and ignores other differences such as case and diacritics.排序强度为1时,只比较基本字符,而忽略大小写和变音符号等其他差异。

Next, insert three example documents:接下来,插入三个示例文档:

db.myColl.insertMany([
   { _id: 1, name: "cafe" },
   { _id: 2, name: "Cafe" },
   { _id: 3, name: "café" }
])

The following $replaceOne operation tries to find and replace the first instance of “Cafe” in the name field:以下$replaceOne操作尝试在name字段中查找并替换“Cafe”的第一个实例:

db.myColl.aggregate([
  {
    $addFields:
      {
        resultObject: { $replaceOne: { input: "$name", find: "Cafe", replacement: "CAFE" } }
      }
  }
])

Because $replaceOne ignores the collation configured for this collection, the operation only matches the instance of “Cafe” in document 2:由于$replaceOne忽略为此集合配置的排序规则,因此该操作仅与文档2中的“Cafe”实例匹配:

{ "_id" : 1, "name" : "cafe", "resultObject" : "cafe" }
{ "_id" : 2, "name" : "Cafe", "resultObject" : "CAFE" }{ "_id" : 3, "name" : "café", "resultObject" : "café" }

Operators which respect collation, such as $match, would match all three documents when performing a string comparison against “Cafe” due to this collection’s collation strength of 1.考虑排序规则(例如$match)的运算符将在与“Cafe”进行字符串比较时匹配所有三个文档,因为该集合的排序强度为1

$replaceOne and Unicode Normalization和Unicode规范化

The $replaceOne aggregation expression does not perform any unicode normalization. $replaceOne聚合表达式不执行任何unicode规范化。This means that string matching for all $replaceOne expressions will consider the number of code points used to represent a character in unicode when attempting a match.这意味着,在尝试匹配时,所有$replaceOne表达式的字符串匹配将考虑用于在unicode中表示字符的代码点数。

For example, the character é can be represented in unicode using either one code point or two:例如,可以使用一个或两个代码点用unicode表示字符é

UnicodeDisplays as显示为Code points代码点
\xe9 é 1 ( \xe9 )
e\u0301 é 2 ( e + \u0301 )

Using $replaceOne with a find string where the character é is represented in unicode with one code point will not match any instance of é that uses two code points in the input string.如果将$replaceOne与一个find字符串一起使用,而该字符串是用unicode表示的,且带有一个代码点,则与在输入字符串中使用两个代码点的任何é实例都不匹配。

The following table shows whether a match occurs for a find string of “café” when compared to input strings where é is represented by either one code point or two. 下表显示了“café”的find字符串与由一个或两个代码点é表示的input字符串相比是否匹配。The find string in this example uses one code point to represent the é character:本例中的find字符串使用一个代码点来表示字符é

Example示例Match
{ $replaceOne: { input: "caf\xe9", find: "café", replacement: "CAFE" } } yes
{ $replaceOne: { input: "cafe\u0301", find: "café", replacement: "CAFE" } } no

Because $replaceOne does not perform any unicode normalization, only the first string comparison matches, where both the find and input strings use one code point to represent é.因为$replaceOne不执行任何unicode规范化,所以只有第一个字符串比较匹配,其中findinput字符串都使用一个代码点来表示é

Example示例

Create an inventory collection with the following documents:使用以下文档创建inventory集合:

db.inventory.insertMany([
   { "_id" : 1, "item" : "blue paint" },
   { "_id" : 2, "item" : "blue and green paint" },
   { "_id" : 3, "item" : "blue paint with blue paintbrush" },
   { "_id" : 4, "item" : "blue paint with green paintbrush" },
])

The following example replaces the first instance of “blue paint” in the item field with “red paint”:以下示例将item字段中的第一个“蓝色油漆”实例替换为“红色油漆”:

db.inventory.aggregate([
   {
     $project:
      {
         item: { $replaceOne: { input: "$item", find: "blue paint", replacement: "red paint" } }
      }
   }
])

The operation returns the following results:操作返回以下结果:

{ "_id" : 1, "item" : "red paint" }
{ "_id" : 2, "item" : "blue and green paint" }
{ "_id" : 3, "item" : "red paint with blue paintbrush" }
{ "_id" : 4, "item" : "red paint with green paintbrush" }

Note that with document 3, only the first matched instance of “blue paint” is replaced.注意,对于文档3,只替换了“blue paint”的第一个匹配实例。