$regex (operador de predicado de query)

$regex vs. /Patrón/ sintaxis

{ name: { $in: [ /^acme/i, /^ack/ ] } }

{ name: { $regex: /acme.*corp/i, $nin: [ 'acmeblahcorp' ] } }
{ name: { $regex: /acme.*corp/, $options: 'i', $nin: [ 'acmeblahcorp' ] } }
{ name: { $regex: 'acme.*corp', $options: 'i', $nin: [ 'acmeblahcorp' ] } }

{ name: { $regex: /acme.*corp/, $options: "si" } }
{ name: { $regex: 'acme.*corp', $options: "si" } }

{ name: { $regex: "(?i)a(?-i)cme" } }

Uso del índice

El uso del índice y el rendimiento para las consultas $regex dependen de si la consulta distingue entre mayúsculas y minúsculas o no.

Realice una LIKE coincidencia

El siguiente ejemplo coincide con todos los documentos donde el campo sku es similar a "%789":

db.products.find( { sku: { $regex: /789$/ } } )

El ejemplo es similar a la siguiente instrucción SQL LIKE:

SELECT * FROM products
WHERE sku like "%789";

Ejemplo de salida:

[
   { _id: 101, sku: 'abc789', description: 'First line\nSecond line' },
   { _id: 103, sku: 'xyz789', description: 'Multiple\nline description' },
   { _id: 104, sku: 'Abc789', description: 'SKU starts with A' }
]

Realizar una coincidencia de expresión regular sin distinguir entre mayúsculas y minúsculas

El siguiente ejemplo utiliza la opción i para realizar una coincidencia que no distingue entre mayúsculas y minúsculas para los valores sku que comienzan con ABC:

db.products.find( { sku: { $regex: /^ABC/i } } )

Ejemplo de salida:

[
   { _id: 100, sku: 'abc123', description: 'Single line description.' },
   { _id: 101, sku: 'abc789', description: 'First line\nSecond line' },
   { _id: 104, sku: 'Abc789', description: 'SKU starts with A' }
]

Emparejar solo palabras completas

Utilice el ancla de límite de palabra \b para que coincida únicamente con palabras completas. Un límite de palabra coincide con la posición entre un carácter de palabra y un carácter que no es de palabra, o al principio o al final de una cadena.

El siguiente ejemplo coincide con documentos donde el campo description contiene la palabra line como palabra completa, pero no como parte de otra palabra como multiline:

db.products.find( { description: { $regex: /\bline\b/ } } )

[
   { _id: 100, sku: 'abc123', description: 'Single line description.' },
   { _id: 101, sku: 'abc789', description: 'First line\nSecond line' },
   { _id: 102, sku: 'xyz456', description: 'Many spaces before     line' }
]

MongoDB no devuelve el documento con _id: 103 porque su campo description contiene line solo como parte de la palabra Multiple\nline. El \n (salto de línea) actúa como límite de palabra para la segunda aparición.

Coincidencia de múltiples líneas para líneas que comienzan con un patrón especificado

El siguiente ejemplo utiliza la opción m para coincidir líneas que comienzan con la letra S en cadenas de texto multilínea:

db.products.find( { description: { $regex: /^S/, $options: 'm' } } )

Ejemplo de salida:

[
   { _id: 100, sku: 'abc123', description: 'Single line description.' },
   { _id: 101, sku: 'abc789', description: 'First line\nSecond line' },
   { _id: 104, sku: 'Abc789', description: 'SKU starts with A' }
]

Sin la opción m, el resultado de ejemplo es:

[
   { _id: 100, sku: 'abc123', description: 'Single line description.' },
   { _id: 104, sku: 'Abc789', description: 'SKU starts with A' }
]

Si el patrón $regex no contiene un ancla, el patrón coincide con toda la cadena. Por ejemplo:

db.products.find( { description: { $regex: /S/ } } )

Ejemplo de salida:

[
   { _id: 100, sku: 'abc123', description: 'Single line description.' },
   { _id: 101, sku: 'abc789', description: 'First line\nSecond line' },
   { _id: 104, sku: 'Abc789', description: 'SKU starts with A' }
]

Utiliza el . Caracter de punto para hacer coincidir una nueva línea

El siguiente ejemplo utiliza la s opción para permitir que el carácter de punto. () coincida con todos los caracteres,incluido el salto de línea, y la i opción para realizar una coincidencia que no distinga entre mayúsculas y minúsculas:

db.products.find( { description: { $regex: /m.*line/, $options: 'si' } } )

Ejemplo de salida:

[
   { _id: 102, sku: 'xyz456', description: 'Many spaces before     line' },
   { _id: 103, sku: 'xyz789', description: 'Multiple\nline description' }
]

Sin la opción s, la consulta devuelve:

[
   { _id: 102, sku: 'xyz456', description: 'Many spaces before     line' }
]

Ignorar los espacios en blanco en el patrón

El siguiente ejemplo utiliza la opción x para ignorar los espacios en blanco y los comentarios, indicados por el # y que terminan con el \n en el patrón de coincidencia:

var pattern = "abc #category code\n123 #item number"
db.products.find( { sku: { $regex: pattern, $options: "x" } } )

Ejemplo de salida:

[
   { _id: 100, sku: 'abc123', description: 'Single line description.' }
]

Utiliza una expresión regular para coincidir con mayúsculas y minúsculas en las cadenas

El siguiente ejemplo utiliza la expresión regular "(?i)a(?-i)bc" para coincidir con las cadenas de campo sku que contienen:

• "abc"

• "Abc"

db.products.find( { sku: { $regex: "(?i)a(?-i)bc" } } )

Ejemplo de salida:

[
   { _id: 100, sku: 'abc123', description: 'Single line description.' },
   { _id: 101, sku: 'abc789', description: 'First line\nSecond line' },
   { _id: 104, sku: 'Abc789', description: 'SKU starts with A' }
]

Extiende las opciones de Regex para que coincidan con caracteres fuera de ASCII

Por defecto, algunas opciones de expresiones regulares (como /b y /w) solo reconocen caracteres ASCII. Esto puede provocar resultados inesperados al realizar coincidencias de expresiones regulares con caracteres UTF-8.

A partir de MongoDB 6.1, puede especificar la opción *UCP de regex para que coincida con caracteres UTF-8.

Por ejemplo, considere los siguientes documentos en una colección songs:

db.songs.insertMany( [
   { _id: 0, "artist" : "Blue Öyster Cult", "title": "The Reaper" },
   { _id: 1, "artist": "Blue Öyster Cult", "title": "Godzilla" },
   { _id: 2, "artist" : "Blue Oyster Cult", "title": "Take Me Away" }
] )

El siguiente query de expresiones regulares utiliza la opción \b en una coincidencia de regex. La opción \b coincide con un límite de palabra.

db.songs.find( { artist: { $regex: /\byster/ } } )

Ejemplo de salida:

[
   { _id: 0, artist: 'Blue Öyster Cult', title: 'The Reaper' },
   { _id: 1, artist: 'Blue Öyster Cult', title: 'Godzilla' }
]

Los resultados anteriores son inesperados porque ninguna de las palabras completas en los campos artist devueltos comienza con la cadena coincidente (yster). El carácter Ö en los documentos _id: 0 y _id: 1 se ignora al realizar la coincidencia porque Ö es un carácter UTF-8.

El resultado esperado es que la consulta no devuelva ningún documento.

Para permitir que el query reconozca los caracteres UTF-8, especifica la opción *UCP antes del patrón:

db.songs.find( { artist: { $regex: "(*UCP)/\byster/" } } )

La consulta anterior no devuelve ningún documento, que es el resultado esperado porque ninguna de las palabras completas en los campos artist comienza con la cadena yster.