$indexOfCP (operador de expressão )

Definição

$indexOfCP

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

$indexOfCP has the following operator expression syntax:

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

Campo	Tipo	Descrição
<string>	string	Pode ser qualquer expressão válida desde que resolva para uma string. Para mais informações sobre expressões, consulte Expressões. If the string expression resolves to a value of null or refers to a field that is missing, $indexOfCP returns null. If the string expression does not resolve to a string or null nor refers to a missing field, $indexOfCP returns an error.
<substring>	string	Pode ser qualquer expressão válida desde que resolva para uma string. Para mais informações sobre expressões, consulte Expressões.
<start>	inteiro	Opcional. Um inteiro ou um número que pode ser representado como inteiros (como 2.0), que especifica a posição inicial do índice para a pesquisa. Pode ser qualquer expressão válida que resolva um número integral não negativo. Se não for especificado, a posição do índice inicial para a pesquisa é o início da string.
<end>	inteiro	Optional. An integer, or a number that can be represented as integers (such as 2.0), 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, $indexOfCP uses the <end> value as the <start> index value instead of the <end> value. Se não for especificado, a posição do índice final para a pesquisa é o final da string.

Comportamento

If the <substring expression> is found multiple times within the <string expression>, then $indexOfCP returns the index of the first <substring expression> found from the starting index position.

$indexOfCP returns null:

• Se <string expression> for nulo, ou

• Se <string expression> se referir a um campo inexistente no documento de entrada.

$indexOfCP retorna um erro:

• Se <string expression> não for uma string e não nulo, ou

• Se <substring expression> for nulo ou não for uma string ou se referir a um campo inexistente no documento de entrada, ou

• Se <start> ou <end> for um número inteiro negativo (ou um valor que pode ser representado como um número inteiro negativo, como -5,0).

$indexOfCP returns -1:

• Se a substring não for encontrada no <string expression>, ou

• Se <start> for um número maior que <end>, ou

• Se <start> for um número maior que o comprimento de bytes da string.

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

The following operation uses the $indexOfCP operator to return the code point index at which the string foo is located in each item string:

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

A operação retorna os seguintes resultados:

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