$ regexFind（汇总）_MonogDB 中文网

MongoDB 中文手册

参考 > 参考 > 经营者 > 聚合管道运营商 > $ regexFind（汇总）

在本页面

定义
句法
行为
例子

定义¶

$regexFind¶

4.2版中的新功能。

在聚合表达式中提供正则表达式（regex）模式匹配功能。如果找到匹配项，则返回包含有关第一个匹配项信息的文档。如果找不到匹配项，则返回null。

MongoDB使用支持UTF-8的Perl兼容正则表达式（即“ PCRE”）版本8.41。

在MongoDB 4.2之前，聚合管道只能$regex在$match阶段中使用查询运算符。有关在查询中使用正则表达式的更多信息，请参见$regex。

语法¶

该$regexFind操作的语法如下：

复制

{ $regexFind: { input: <expression> , regex: <expression>, options: <expression> } }

运算符字段¶

领域描述

输入

您希望在其上应用正则表达式模式的字符串。可以是字符串或任何可解析为字符串的有效表达式。

正则表达式

要应用的正则表达式模式。可以是任何可解析为字符串或正则表达式模式的有效表达式/<pattern>/。使用regex时/<patthern>/，还可以指定regex选项i和m（但不能指定 sor x选项）：

"pattern"
/<pattern>/
/<pattern>/<options>

另外，您也可以在options字段中指定正则表达式选项。要指定s或x选项，必须使用options字段。

您不能在regex和options 字段中同时指定选项。

选项

可选的。以下内容<options>可用于正则表达式。

注意

您不能在regex和 options字段中同时指定选项。

选项	描述
`i`	不区分大小写以匹配大小写。您可以在`options`字段中或正则表达式字段中指定选项。
`m`	对于包含锚点的模式（即`^`开始， `$`结束），请在每行的开头或结尾匹配具有多行值的字符串。如果没有此选项，这些锚点将在字符串的开头或结尾匹配。如果模式不包含锚点，或者字符串值不包含换行符（例如`\n`），则该`m`选项无效。
`x`	“扩展”功能可以忽略模式中的所有空白字符，除非转义或包含在字符类中。此外，它会忽略中间的字符，包括未转义的井号/磅（`#`）字符和下一个新行，因此您可以在复杂模式中添加注释。这仅适用于数据字符；空格字符永远不会出现在图案的特殊字符序列中。该`x`选项不影响VT字符（即代码11）的处理。您只能在`options`字段中指定选项。
`s`	允许点字符（即`.`）匹配所有字符，包括换行符。您只能在`options`字段中指定选项。

返回¶

如果运算符未找到匹配项，则运算符的结果为 null。

如果运算符找到匹配项，则运算符的结果将是一个包含以下内容的文档：

输入中的第一个匹配字符串，
输入中匹配字符串的代码点索引（不是字节索引），以及
字符串数组，与匹配字符串捕获的组相对应。捕获组()在正则表达式模式中用不转义的括号指定。

{ "match" : <string>, "idx" : <num>, "captures" : <array of strings> }

也可以看看

行为¶

`$regexFind`和排序规则¶

$regexFind忽略为collection指定的归类db.collection.aggregate()和索引（如果使用）。

例如，创建一个具有整理强度的样本集合 1（即仅比较基本字符而忽略其他区别，例如大小写和变音符号）：

复制

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

插入以下文件：

复制

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

使用集合的排序规则，以下操作将执行不区分大小写和不区分音素的匹配：

复制

db.myColl.aggregate( [ { $match: { category: "cafe" } } ] )

该操作返回以下3个文档：

复制

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

但是，聚合表达式会$regexFind忽略排序规则；也就是说，以下正则表达式模式匹配示例区分大小写和变音符号：

复制

db.myColl.aggregate( [ { $addFields: { resultObject: { $regexFind: { input: "$category", regex: /cafe/ }  } } } ] )
db.myColl.aggregate(
   [ { $addFields: { resultObject: { $regexFind: { input: "$category", regex: /cafe/ }  } } } ],
   { collation: { locale: "fr", strength: 1 } }           // Ignored in the $regexFind
)

这两个操作都返回以下内容：

复制

{ "_id" : 1, "category" : "café", "resultObject" : null }
{ "_id" : 2, "category" : "cafe", "resultObject" : { "match" : "cafe", "idx" : 0, "captures" : [ ] } }
{ "_id" : 3, "category" : "cafE", "resultObject" : null }

要执行不区分大小写的正则表达式模式匹配，请改用 i Option。有关示例，请参见 i选项。

`captures`输出行为¶

如果您的正则表达式模式包含捕获组，并且该模式在input中找到匹配项captures，则结果中的数组将与匹配字符串捕获的组相对应。捕获组()在正则表达式模式中用不转义的括号指定。captures阵列的长度等于模式中捕获组的数量，并且阵列的顺序与捕获组出现的顺序匹配。

创建一个contacts使用以下文档命名的样本集合：

复制

db.contacts.insertMany([
  { "_id": 1, "fname": "Carol", "lname": "Smith", "phone": "718-555-0113" },
  { "_id": 2, "fname": "Daryl", "lname": "Doe", "phone": "212-555-8832" },
  { "_id": 3, "fname": "Polly", "lname": "Andrews", "phone": "208-555-1932" },
  { "_id": 4, "fname": "Colleen", "lname": "Duncan", "phone": "775-555-0187" },
  { "_id": 5, "fname": "Luna", "lname": "Clarke", "phone": "917-555-4414" }
])

以下管道将正则表达式模式/(C(ar)*)ol/应用于fname字段：

复制

db.contacts.aggregate([
  {
    $project: {
      returnObject: {
        $regexFind: { input: "$fname", regex: /(C(ar)*)ol/ }
      }
    }
  }
])

该正则表达式模式找到具有匹配fname 值Carol和Colleen：

{ "_id" : 1, "returnObject" : { "match" : "Carol", "idx" : 0, "captures" : [ "Car", "ar" ] } }
{ "_id" : 2, "returnObject" : null }
{ "_id" : 3, "returnObject" : null }
{ "_id" : 4, "returnObject" : { "match" : "Col", "idx" : 0, "captures" : [ "C", null ] } }
{ "_id" : 5, "returnObject" : null }

模式包含捕获组(C(ar)*)，捕获组包含嵌套组(ar)。captures数组中的元素对应于两个捕获组。如果某个组（例如Colleen和组(ar)）没有捕获到匹配的文档，则$regexFind用空的占位符替换该组。

如上例所示，该captures数组包含每个捕获组的元素（null用于非捕获）。考虑以下示例，该示例通过将or捕获组逻辑应用于phone字段来搜索带有纽约市区号的电话号码。每个组代表一个纽约市区号：

复制

db.contacts.aggregate([
  {
    $project: {
      nycContacts: {
        $regexFind: { input: "$phone", regex: /^(718).*|^(212).*|^(917).*/ }
      }
    }
  }
])

对于正则表达式模式匹配的文档，captures数组包括匹配的捕获组，并用替换所有非捕获组null：

{ "_id" : 1, "nycContacts" : { "match" : "718-555-0113", "idx" : 0, "captures" : [ "718", null, null ] } }
{ "_id" : 2, "nycContacts" : { "match" : "212-555-8832", "idx" : 0, "captures" : [ null, "212", null ] } }
{ "_id" : 3, "nycContacts" : null }
{ "_id" : 4, "nycContacts" : null }
{ "_id" : 5, "nycContacts" : { "match" : "917-555-4414", "idx" : 0, "captures" : [ null, null, "917" ] } }

例子¶

`$regexFind`及其选项¶

为了说明$regexFind此示例中讨论的操作员的行为，请products使用以下文档创建样本集合：

复制

db.products.insertMany([
   { _id: 1, description: "Single LINE description." },
   { _id: 2, description: "First lines\nsecond line" },
   { _id: 3, description: "Many spaces before     line" },
   { _id: 4, description: "Multiple\nline descriptions" },
   { _id: 5, description: "anchors, links and hyperlinks" },
   { _id: 6, description: "métier work vocation" }
])

默认情况下，$regexFind执行区分大小写的匹配。例如，以下聚合在字段上区分大小写 。正则表达式模式不指定任何分组：$regexFinddescription/line/

复制

db.products.aggregate([
   { $addFields: { returnObject: { $regexFind: { input: "$description", regex: /line/ } } } }
])

该操作返回以下内容：

{ "_id" : 1, "description" : "Single LINE description.", "returnObject" : null }
{ "_id" : 2, "description" : "First lines\nsecond line", "returnObject" : { "match" : "line", "idx" : 6, "captures" : [ ] } }
{ "_id" : 3, "description" : "Many spaces before     line", "returnObject" : { "match" : "line", "idx" : 23, "captures" : [ ] } }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "returnObject" : { "match" : "line", "idx" : 9, "captures" : [ ] } }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "returnObject" : null }
{ "_id" : 6, "description" : "métier work vocation", "returnObject" : null }

以下正则表达式模式在模式中/lin(e|k)/指定了一个分组 (e|k)：

复制

db.products.aggregate([
   { $addFields: { returnObject: { $regexFind: { input: "$description", regex: /lin(e|k)/ } } } }
])

该操作返回以下内容：

{ "_id" : 1, "description" : "Single LINE description.", "returnObject" : null }
{ "_id" : 2, "description" : "First lines\nsecond line", "returnObject" : { "match" : "line", "idx" : 6, "captures" : [ "e" ] } }
{ "_id" : 3, "description" : "Many spaces before     line", "returnObject" : { "match" : "line", "idx" : 23, "captures" : [ "e" ] } }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "returnObject" : { "match" : "line", "idx" : 9, "captures" : [ "e" ] } }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "returnObject" : { "match" : "link", "idx" : 9, "captures" : [ "k" ] } }
{ "_id" : 6, "description" : "métier work vocation", "returnObject" : null }

在return选项中，该idx字段是代码点索引，而不是字节索引。为了说明，请考虑以下使用regex模式的示例/tier/：

复制

db.products.aggregate([
   { $addFields: { returnObject: { $regexFind: { input: "$description", regex: /tier/ } } } }
])

该操作返回以下内容，其中只有最后一条记录与模式匹配，并且返回的idx是2（如果使用字节索引，则返回3）

{ "_id" : 1, "description" : "Single LINE description.", "returnObject" : null }
{ "_id" : 2, "description" : "First lines\nsecond line", "returnObject" : null }
{ "_id" : 3, "description" : "Many spaces before     line", "returnObject" : null }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "returnObject" : null }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "returnObject" : null }
{ "_id" : 6, "description" : "métier work vocation",
             "returnObject" : { "match" : "tier", "idx" : 2, "captures" : [ ] } }

`i`选项¶

注意

您不能在regex和 options字段中同时指定选项。

要执行不区分大小写的模式匹配，请在正则表达式字段或选项字段中包括i选项：

// Specify i as part of the regex field
{ $regexFind: { input: "$description", regex: /line/i } }

// Specify i in the options field
{ $regexFind: { input: "$description", regex: /line/, options: "i" } }
{ $regexFind: { input: "$description", regex: "line", options: "i" } }

例如，以下聚合对字段执行不区分大小写 $regexFind的操作description。正则表达式模式/line/不指定任何分组：

复制

db.products.aggregate([
   { $addFields: { returnObject: { $regexFind: { input: "$description", regex: /line/i } } } }
])

该操作返回以下文档：

{ "_id" : 1, "description" : "Single LINE description.", "returnObject" : { "match" : "LINE", "idx" : 7, "captures" : [ ] } }
{ "_id" : 2, "description" : "First lines\nsecond line", "returnObject" : { "match" : "line", "idx" : 6, "captures" : [ ] } }
{ "_id" : 3, "description" : "Many spaces before     line", "returnObject" : { "match" : "line", "idx" : 23, "captures" : [ ] } }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "returnObject" : { "match" : "line", "idx" : 9, "captures" : [ ] } }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "returnObject" : null }
{ "_id" : 6, "description" : "métier work vocation", "returnObject" : null }

`m`选项¶

注意

您不能在regex和 options字段中同时指定选项。

以匹配指定的锚定件（例如^，$用于多行字符串的每一行），包括米选项作为的一部分的正则表达式字段或

MongoDB 中文手册

$ regexFind（汇总）

定义¶

语法¶

运算符字段¶

返回¶

行为¶

$regexFind和排序规则¶

captures输出行为¶

例子¶

$regexFind及其选项¶

i选项¶

m选项¶

`$regexFind`和排序规则¶

`captures`输出行为¶

`$regexFind`及其选项¶

`i`选项¶

`m`选项¶