$indexOfBytes (operador de expressão )

Definição

$indexOfBytes

Pesquisa uma string para uma ocorrência de uma substring e retorna o índice de bytes UTF-8 (com base em zero) da primeira ocorrência. Se a substring não for encontrada, retorna -1.

$indexOfBytes tem a seguinte sintaxe de expressão do operador :

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

Operando	Descrição
<string expression>	Pode ser qualquer expressão válida desde que resolva para uma string. Para mais informações sobre expressões, consulte Expressões. Se a expressão de string for resolvida para um valor de null ou se referir a um campo ausente, $indexOfBytes nullretornará. Se a expressão de string não se resolver em uma string ou null nem se referir a um campo ausente, retornará um$indexOfBytes erro.
<substring expression>	Pode ser qualquer expressão válida desde que resolva para uma string. Para mais informações sobre expressões, consulte Expressões.
<start>	Opcional Um número integral que especifica a posição do índice inicial para a Atlas Search. Pode ser qualquer expressão válida que resolva um número integral não negativo.
<end>	Opcional Um número integral que especifica a posição do índice final para a pesquisa. Pode ser qualquer expressão válida que resolva um número integral não negativo. Se você especificar um <end> valor de índice, também deverá especificar um <start> valor de índice; caso contrário, utiliza$indexOfBytes o <end> valor como o <start> valor do índice em vez do <end> valor.

Comportamento

• Se <string expression> for nulo, $indexOfBytes nullretornará.

• Se for chamado em um campo que não existe no $indexOfBytes documento, $indexOfBytes nullretornará.

• Se <string expression> não for uma string e não nulo, retornará um$indexOfBytes erro.

• Se <substring expression> for nulo, retornará um$indexOfBytes erro.

• Se <start> ou <end> for um número negativo, retornará um$indexOfBytes erro.

• Se <start> for um número maior que,<end> $indexOfBytes -1retornará.

• Se <start> for um número maior que o comprimento em bytes da string, $indexOfBytes -1retornará.

• Se <start> ou <end> receber um valor que não é um número inteiro, retornará um$indexOfBytes erro.

• Se <substring expression> for encontrado várias vezes dentro <string expression> de, então retornará o índice do $indexOfBytes primeiro <substring expression> encontrado.

Alguns exemplos curtos para destacar comportamentos diferentes:

Exemplos

Considere uma coleção inventory com os seguintes documentos:

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 }
] )

A seguinte operação utiliza o operador para recuperar os índices nos quais a $indexOfBytes string foo está localizada em cada item:

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

A operação retorna os seguintes resultados:

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