MongoDB聚合运算符：$indexOfBytes

文章目录

- 语法
- 使用
- 举例

$聚合运算符在字符串中搜索子字符串的出现位置并返回第一次出现的 UTF-8字节索引（从零开始）。如果未找到子字符串，则返回-1。

语法

js 复制代码

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

参数说明：

参数	说明
`<string expression>`	字符串表达式，如果表达式的值为`null`或应用的字段缺失，则返回`null`；如果表达式的值不为字符串、null、或字段缺失，则报错
`<substring expression>`	要搜索的字符串，可以是任何可解析为字符串的表达式
`<start>`	可选参数，可解析为大于等于零的整数的表达式，用于指定从什么位置开始搜索
`<end>`	可选参数，可解析为大于等于零的整数的表达式，用于指定搜索的停止位置；如果指定的`<end>`则必须同时指定`<start>`

使用

如果<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>的值不是整数，$indexOfBytesf返回错误
如果<substring expression>在<string expression中多次出现，$indexOfBytes返回第一次发现的位置。

下面是一些例子来说明典型的规则：

举例	结果
`{ $indexOfBytes: [ "cafeteria", "e" ] }`	`3`
`{ $indexOfBytes: [ "cafétéria", "é" ] }`	`3`
`{ $indexOfBytes: [ "cafétéria", "e" ] }`	`-1`
`{ $indexOfBytes: [ "cafétéria", "t" ] }`	`5`
`{ $indexOfBytes: [ "foo.bar.fi", ".", 5 ] }`	`7`
`{ $indexOfBytes: [ "vanilla", "ll", 0, 2 ] }`	`-1`
`{ $indexOfBytes: [ "vanilla", "ll", -1 ] }`	`-1`
`{ $indexOfBytes: [ "vanilla", "ll", 12 ] }`	`-1`
`{ $indexOfBytes: [ "vanilla", "ll", 5, 2 ] }`	`-1`
`{ $indexOfBytes: [ "vanilla", "nilla", 3 ] }`	`-1`
`{ $indexOfBytes: [ null, "foo" ] }`	`null`

举例

inventory集合有下列数据：

json 复制代码

{ "_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在每个item中的位置：

js 复制代码

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

操作的结果如下：

json 复制代码

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