$indexOfCP (operador de expresión)

Definición

$indexOfCP

Busca en un string una ocurrencia de una subcadena y devuelve el punto de código índice (basado en cero) de la primera ocurrencia de código UTF-8. Si no se encuentra la subcadena, devuelve -1.

$indexOfCP tiene la siguiente sintaxis de expresión de operador:

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

Campo	Tipo	Descripción
<string>	string	Puede ser cualquier expresión válida siempre que se resuelva en una string. Para obtener más información sobre las expresiones, consulta Expresiones. Si la expresión de string se resuelve en un valor de null o se refiere a un campo que falta, $indexOfCP devuelve null. Si la expresión de string no se resuelve en una string o null, ni se refiere a un campo faltante, $indexOfCP devuelve un error.
<substring>	string	Puede ser cualquier expresión válida siempre que se resuelva en una string. Para obtener más información sobre las expresiones, consulta Expresiones.
<start>	entero	opcional. Un entero, o un número que pueda representarse como enteros (como 2.0), que especifica la posición del índice inicial para la búsqueda. Puede ser cualquier expresión válida que resuelva a un número integral no negativo. Si no se especifica, la posición inicial del índice para la búsqueda es el comienzo de la string.
<end>	entero	opcional. Un entero, o un número que se puede representar como enteros (como 2.0), que especifica la posición del índice final para la búsqueda. Puede ser cualquier expresión válida que resuelva a un número integral no negativo. Si especifica un valor de índice <end>, también debe especificar un valor de índice <start>; de lo contrario, $indexOfCP utiliza el valor <end> como valor de índice <start> en lugar del valor <end>. Si no se especifica, la posición de índice de finalización de la búsqueda es el final de la string.

Comportamiento

Si se encuentra el <substring expression> varias veces dentro del <string expression>, entonces $indexOfCP devuelve el índice del primer <substring expression> encontrado desde la posición inicial del índice.

$indexOfCP devuelve null:

• Si <string expression> es nulo, o

• Si <string expression> se refiere a un campo inexistente en el documento de entrada.

$indexOfCP devuelve un error:

• Si <string expression> no es una cadena y no es nulo, o

• Si <substring expression> es nulo o no es una string o se refiere a un campo inexistente en el documento de entrada, o

• Si <start> o <end> es un entero negativo (o un valor que puede representarse como un entero negativo, como -5.0).

$indexOfCP devuelve -1:

• Si la subcadena no se encuentra en el <string expression>, o

• Si <start> es un número mayor que <end>, o

• Si <start> es un número mayor que la longitud de bytes de la string.

Ejemplos

Considere una colección inventory con los siguientes 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 }
] )

La siguiente operación utiliza el operador $indexOfCP para devolver el índice de punto de código en el que se encuentra la cadena foo en cada cadena item:

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

La operación devuelve los siguientes 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 }