$indexOfBytes（聚合）

定义

$indexOfBytes

在字符串中搜索子字符串的第一次出现，并返回该出现的UTF-8字节索引（基于0）。如果未找到子字符串，则返回-1。

$indexOfBytes具有以下操作表达式语法:

{ $indexOfBytes: [ <string expression>, <substring expression>, <start>, <end> ] }

操作数	描述
<string expression>	可以是任何有效的表达式，只要它解析为一个字符串。有关表达式更多信息，请参阅表达式运算符。 如果字符串表达式解析为null或引用一个缺失的字段，则$indexOfBytes返回null。 如果字符串表达式没有解析为字符串或null，也不引用一个缺失的字段，则$indexOfBytes返回一个错误。
<substring expression>	可以是任何有效的表达式，只要它解析为一个字符串。有关表达式更多信息，请参阅表达式运算符。
<start>	可选一个整数，指定搜索的起始索引位置。可以是任何有效的表达式，该表达式解析为一个非负整数。
<end>	可选 一个整数，指定搜索的结束索引位置。可以是任何有效的 表达式，其结果为一个非负整数。如果您指定了 <end> 索引值，也应该指定一个 <start> 索引值；否则，$indexOfBytes 将使用 <end> 值作为 <start> 索引值，而不是 <end> 值。

行为

• 如果 <string expression> 是 null，$indexOfBytes 返回 null。

• 如果 $indexOfBytes 被调用在一个文档中不存在的字段上，$indexOfBytes 返回 null。

• 如果 <string expression> 不是一个字符串且不是 null，$indexOfBytes 返回一个错误。

• 如果 <substring expression> 是 null，$indexOfBytes 返回一个错误。

• 如果 <start> 或 <end> 是一个负数，$indexOfBytes 返回一个错误。

• 如果 <start> 是一个大于 <end> 的数字，$indexOfBytes 返回 -1。

• 如果 <start> 是一个大于字符串的字节长度的数字，$indexOfBytes 返回 -1。

• 如果 <start> 或 <end> 给定一个非整数值，$indexOfBytes 返回一个错误。

• 如果 <substring expression> 在 <string expression> 中被找到多次，那么 $indexOfBytes 返回第一个找到的 <substring expression> 的索引。

一些简短的例子来突出不同的行为

示例

考虑以下文档的 库存 集合

{ "_id" : 1, "item" : "foo" }
{ "_id" : 2, "item" : "fóofoo" }
{ "_id" : 3, "item" : "the foo bar" }
{ "_id" : 4, "item" : "hello world fóo" }
{ "_id" : 5, "item" : null }
{ "_id" : 6, "amount" : 3 }

以下操作使用 $indexOfBytes 操作符检索字符串 foo 在每个项目中的索引位置

db.inventory.aggregate(
   [
     {
       $project:
          {
            byteLocation: { $indexOfBytes: [ "$item", "foo" ] },
          }
      }
   ]
)

操作返回以下结果

{ "_id" : 1, "byteLocation" : "0" }
{ "_id" : 2, "byteLocation" : "4" }
{ "_id" : 3, "byteLocation" : "4" }
{ "_id" : 4, "byteLocation" : "-1" }
{ "_id" : 5, "byteLocation" : null }
{ "_id" : 6, "byteLocation" : null }