$indexOfBytes（式演算子）

定義

$indexOfBytes

string から部分文字列を検索し、最初に出現した string の UTF- 8バイトインデックス（ゼロベース）を返します。 部分文字列が見つからない場合は、 -1を返します。

$indexOfBytes has the following operator expression syntax:

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

オペランド	説明
<string expression>	に変換される限り、任意の有効な 式 stringを指定できます。式の詳細については、「式 」を参照してください。 If the string expression resolves to a value of null or refers to a field that is missing, $indexOfBytes returns null. If the string expression does not resolve to a string or null nor refers to a missing field, $indexOfBytes returns an error.
<substring expression>	に変換される限り、任意の有効な 式 stringを指定できます。式の詳細については、「式 」を参照してください。
<start>	任意検索の開始インデックス位置を指定する整数。 負でない整数に変換される任意の有効な式を指定できます。
<end>	Optional An integral number that specifies the ending index position for the search. Can be any valid expression that resolves to a non-negative integral number. If you specify a <end> index value, you should also specify a <start> index value; otherwise, $indexOfBytes uses the <end> value as the <start> index value instead of the <end> value.

動作

• If <string expression> is null, $indexOfBytes returns null.

• If $indexOfBytes is called on a field that doesn't exist in the document, $indexOfBytes returns null.

• If <string expression> is not a string and not null, $indexOfBytes returns an error.

• If <substring expression> is null, $indexOfBytes returns an error.

• If <start> or <end> is a negative number, $indexOfBytes returns an error.

• If <start> is a number greater than <end>, $indexOfBytes returns -1.

• If <start> is a number greater than the byte length of the string, $indexOfBytes returns -1.

• If <start> or <end> is given a value that is not an integer, $indexOfBytes returns an error.

• If the <substring expression> is found multiple times within the <string expression>, then $indexOfBytes returns the index of the first <substring expression> found.

異なる動作を示す短い例をいくつか示します。

例

以下のドキュメントを持つinventoryコレクションを検討してください。

db.inventory.insertMany( [
   { _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 }
] )

The following operation uses the $indexOfBytes operator to retrieve the indexes at which the string foo is located in each item:

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 }