/ /

Operadores

Operadores de pipeline de agregación

Docs Home

Manual de base de datos

Referencia

Operadores

Operadores de pipeline de agregación

$regexMatch (agregación)

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 6.0, consulta el Procedimientos de actualización de MongoDB 7.0 .

Definición

$regexMatch

Realiza una coincidencia de patrones de expresión regular (regex) y devuelve:

true si existe una coincidencia.
false si no existe una coincidencia.

MongoDB utiliza expresiones regulares compatibles con Perl (es decir, "PCRE" ) versión 8.41 con soporte UTF-8.

Sintaxis

El operador $regexMatch tiene la siguiente sintaxis:

{ $regexMatch: { input: <expression> , regex: <expression>, options: <expression> } }

Campo

Descripción

entrada

La string a la que deseas aplicar el patrón regex. Puede ser un string o cualquier expresión válida que se resuelva en un string.

regex

El patrón regex a aplicar. Puede ser cualquier expresión válida que se resuelva en una string o patrón regex /<pattern>/. Al usar la expresión regular /<pattern>/, también puedes especificar las opciones de expresión regular i y m (pero no las opciones s o x):

"pattern"
/<pattern>/
/<pattern>/<options>

Alternativamente, también puedes especificar las opciones de regex en el campo opciones. Para especificar las opciones s o x, debes utilizar el campo opciones.

No se pueden especificar opciones tanto en el campo regex como en el options.

opciones

Opcional. Los siguientes <options> están disponibles para su uso con expresiones regulares.

No se pueden especificar opciones tanto en el campo regex como en el options.

Opción	Descripción
`i`	Insensibilidad a mayúsculas y minúsculas para hacer coincidir tanto mayúsculas como minúsculas. Puedes especificar la opción en el campo `options` o como parte del campo regex.
`m`	Para patrones que incluyen anclajes (es decir, `^` para el inicio, `$` para el final), haz coincidir al principio o al final de cada línea para strings con valores de varias líneas. Sin esta opción, estos anclajes coinciden al principio o al final del string. Si el patrón no contiene anclas o si el valor de la string no tiene caracteres de nueva línea (p. ej., `\n`), la opción `m` no tiene efecto.
`x`	Capacidad “extendida” para ignorar todos los caracteres de espacio en blanco en el patrón, a menos que estén escapados o incluidos en una clase de caracteres. Además, ignora los caracteres entre un carácter de hash/pound (`#`) sin escape y la siguiente nueva línea, para que pueda incluir comentarios en patrones complicados. Esto solo se aplica a los caracteres de datos; los caracteres de espacio en blanco nunca deben aparecer dentro de las secuencias de caracteres especiales en un patrón. La opción `x` no afecta el manejo del carácter VT (es decir, código 11). Puedes especificar la opción solo en el campo `options`.
`s`	Permite el carácter punto (es decir, `.`) para que coincidan todos los caracteres incluidos los caracteres de salto de línea. Puedes especificar la opción solo en el campo `options`.

Devuelve

El operador retorna un valor booleano:

true si existe una coincidencia.
false si no existe una coincidencia.

Tip

Comportamiento

Coincidencia de expresiones regulares e intercalación

String matching para $regexMatch siempre distingue entre mayúsculas y minúsculas, y es sensible a las marcas diacríticas. $regexMatch ignora la intercalación especificada para la colección, db.collection.aggregate(), y el índice, si se utiliza.

Por ejemplo, crear una colección con una fuerza de intercalación 1, lo que significa que la intercalación solo compara caracteres base y no toma en cuenta diferencias como mayúsculas y diacríticos:

db.createCollection( "restaurants", { collation: { locale: "fr", strength: 1 } } )

Inserte los siguientes documentos:

db.restaurants.insertMany( [
   { _id: 1, category: "café", status: "Open" },
   { _id: 2, category: "cafe", status: "open" },
   { _id: 3, category: "cafE", status: "open" }
] )

Lo siguiente utiliza la intercalación de la colección para realizar una coincidencia sin distinción entre mayúsculas y minúsculas y sin sensibilidad a los signos diacríticos:

db.restaurants.aggregate( [ { $match: { category: "cafe" } } ] )

[
   { _id: 1, category: 'café', status: 'Open' },
   { _id: 2, category: 'cafe', status: 'open' },
   { _id: 3, category: 'cafE', status: 'open' }
]

Sin embargo, $regexMatch ignora la intercalación. Los siguientes ejemplos de coincidencias de patrones de expresiones regulares distinguen entre mayúsculas y minúsculas y entre diacríticos:

db.restaurants.aggregate( [
   {
      $addFields: {
         resultObject: { $regexMatch: { input: "$category", regex: /cafe/ } }
      }
   }
] )
db.restaurants.aggregate( [
   {
      $addFields: {
         resultObject: { $regexMatch: { input: "$category", regex: /cafe/ } }
      }
   }
],
   { collation: { locale: "fr", strength: 1 } } // Ignored in the $regexMatch
)

Ambas operaciones devuelven lo siguiente:

{ "_id" : 1, "category" : "café", "resultObject" : null }
{ "_id" : 2, "category" : "cafe", "resultObject" : { "match" : "cafe", "idx" : 0, "captures" : [ ] } }
{ "_id" : 3, "category" : "cafE", "resultObject" : null }

Debido a que la query ignora la intercalación, requiere una coincidencia exacta en la string category (incluyendo mayúsculas y signos diacríticos), lo que significa que solo se empareja el documento _id: 2.

Para realizar una coincidencia de patrón regex que no distinga entre mayúsculas y minúsculas, utiliza la i Opción en su lugar. Ver i Opción para un ejemplo.

Ejemplos

`$regexMatch` y sus opciones

Para ilustrar el comportamiento del operador $regexMatch como se discute en este ejemplo, cree una colección de muestra products con los siguientes documentos:

db.products.insertMany([
   { _id: 1, description: "Single LINE description." },
   { _id: 2, description: "First lines\nsecond line" },
   { _id: 3, description: "Many spaces before     line" },
   { _id: 4, description: "Multiple\nline descriptions" },
   { _id: 5, description: "anchors, links and hyperlinks" },
   { _id: 6, description: "métier work vocation" }
])

Por defecto, $regexMatch realiza una coincidencia sensible a mayúsculas y minúsculas. Por ejemplo, la siguiente agregación realiza unadiferenciación $regexMatch en el campo description. El patrón de expresión regular /line/ no especifica ningún agrupamiento:

db.products.aggregate([
   { $addFields: { result: { $regexMatch: { input: "$description", regex: /line/ } } } }
])

La operación devuelve lo siguiente:

{ "_id" : 1, "description" : "Single LINE description.", "result" : false }
{ "_id" : 2, "description" : "First lines\nsecond line", "result" : true }
{ "_id" : 3, "description" : "Many spaces before     line", "result" : true }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "result" : true }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "result" : false }
{ "_id" : 6, "description" : "métier work vocation", "result" : false }

El siguiente patrón de expresiones regulares /lin(e|k)/ especifica una agrupación (e|k) en el patrón:

db.products.aggregate([
   { $addFields: { result: { $regexMatch: { input: "$description", regex: /lin(e|k)/ } } } }
])

La operación devuelve lo siguiente:

{ "_id" : 1, "description" : "Single LINE description.", "result" : false }
{ "_id" : 2, "description" : "First lines\nsecond line", "result" : true }
{ "_id" : 3, "description" : "Many spaces before     line", "result" : true }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "result" : true }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "result" : true }
{ "_id" : 6, "description" : "métier work vocation", "result" : false }

`i` Opción

Nota

No se pueden especificar opciones tanto en el campo regex como en el options.

Para realizar una concordancia de patronessin distinguir mayúsculas de minúsculas, incluya la opción i como parte del campo regex o en el campo opciones:

// Specify i as part of the regex field
{ $regexMatch: { input: "$description", regex: /line/i } }
// Specify i in the options field
{ $regexMatch: { input: "$description", regex: /line/, options: "i" } }
{ $regexMatch: { input: "$description", regex: "line", options: "i" } }

Por ejemplo, la siguiente agregación realiza un en $regexMatch el description campo. No distingue entre mayúsculas y minúsculas. El patrón de expresión regular /line/ no especifica ningún agrupamiento:

db.products.aggregate([
   { $addFields: { result: { $regexMatch: { input: "$description", regex: /line/i } } } }
])

La operación devuelve los siguientes documentos:

{ "_id" : 1, "description" : "Single LINE description.", "result" : true }
{ "_id" : 2, "description" : "First lines\nsecond line", "result" : true }
{ "_id" : 3, "description" : "Many spaces before     line", "result" : true }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "result" : true }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "result" : false }
{ "_id" : 6, "description" : "métier work vocation", "result" : false }

`m` Opción

Nota

No se pueden especificar opciones tanto en el campo regex como en el options.

Para que coincida con los anclajes especificados (por ejemplo, ^, $) para cada línea de una string multilínea, incluya la opción m como parte del campo regex o en el campo opciones:

// Specify m as part of the regex field
{ $regexMatch: { input: "$description", regex: /line/m } }
// Specify m in the options field
{ $regexMatch: { input: "$description", regex: /line/, options: "m" } }
{ $regexMatch: { input: "$description", regex: "line", options: "m" } }

El siguiente ejemplo incluye tanto las opciones i como m para hacer coincidir las líneas que comienzan con la letra s o S en cadenas multilínea:

db.products.aggregate([
   { $addFields: { result: { $regexMatch: { input: "$description", regex: /^s/im } } } }
])

La operación devuelve lo siguiente:

{ "_id" : 1, "description" : "Single LINE description.", "result" : true }
{ "_id" : 2, "description" : "First lines\nsecond line", "result" : true }
{ "_id" : 3, "description" : "Many spaces before     line", "result" : false }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "result" : false }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "result" : false }
{ "_id" : 6, "description" : "métier work vocation", "result" : false }

`x` Opción

Nota

No se pueden especificar opciones tanto en el campo regex como en el options.

Para ignorar todos los caracteres de espacio en blanco y comentarios sin escape (denotados por el carácter hash # sin escape y el siguiente carácter de nueva línea) en el patrón, incluya la opción s en el campo de opciones:

// Specify x in the options field
{ $regexMatch: { input: "$description", regex: /line/, options: "x" } }
{ $regexMatch: { input: "$description", regex: "line", options: "x" } }

El siguiente ejemplo incluye la opción x para omitir los espacios en blanco sin escape y los comentarios:

db.products.aggregate([
   { $addFields: { returns: { $regexMatch: { input: "$description", regex: /lin(e|k) # matches line or link/, options:"x" } } } }
])

La operación devuelve lo siguiente:

{ "_id" : 1, "description" : "Single LINE description.", "returns" : false }
{ "_id" : 2, "description" : "First lines\nsecond line", "returns" : true }
{ "_id" : 3, "description" : "Many spaces before     line", "returns" : true }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "returns" : true }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "returns" : true }
{ "_id" : 6, "description" : "métier work vocation", "returns" : false }

`s` Opción

Nota

No se pueden especificar opciones tanto en el campo regex como en el options.

Para permitir el carácter de punto (es decir, .) en el patrón para hacer coincidir todos los caracteres, incluido el carácter de nueva línea, incluye la opción s en el campo opciones:

// Specify s in the options field
{ $regexMatch: { input: "$description", regex: /m.*line/, options: "s" } }
{ $regexMatch: { input: "$description", regex: "m.*line", options: "s" } }

El siguiente ejemplo incluye la opción s para permitir que el carácter de punto (es decir, .) coincida con todos los caracteres, incluyendo la nueva línea, así como la opción i para realizar una coincidencia sin distinción entre mayúsculas y minúsculas:

db.products.aggregate([
   { $addFields: { returns: { $regexMatch: { input: "$description", regex:/m.*line/, options: "si"  } } } }
])

La operación devuelve lo siguiente:

{ "_id" : 1, "description" : "Single LINE description.", "returns" : false }
{ "_id" : 2, "description" : "First lines\nsecond line", "returns" : false }
{ "_id" : 3, "description" : "Many spaces before     line", "returns" : true }
{ "_id" : 4, "description" : "Multiple\nline descriptions", "returns" : true }
{ "_id" : 5, "description" : "anchors, links and hyperlinks", "returns" : false }
{ "_id" : 6, "description" : "métier work vocation", "returns" : false }

Utiliza `$regexMatch` para verificar la dirección de correo electrónico

Cree una colección de muestra feedback con los siguientes documentos:

db.feedback.insertMany([
   { "_id" : 1, comment: "Hi, I'm just reading about MongoDB -- aunt.arc.tica@example.com"  },
   { "_id" : 2, comment: "I wanted to concatenate a string" },
   { "_id" : 3, comment: "How do I convert a date to string? Contact me at either cam@mongodb.com or c.dia@mongodb.com" },
   { "_id" : 4, comment: "It's just me. I'm testing.  fred@MongoDB.com" }
])

La siguiente agregación utiliza el $regexMatch para comprobar si el campo comment contiene una dirección de correo electrónico con @mongodb.com y clasifica los comentarios como Employee o External.

db.feedback.aggregate( [
    { $addFields: {
       "category": { $cond: { if:  { $regexMatch: { input: "$comment", regex: /[a-z0-9_.+-]+@mongodb.com/i } },
                              then: "Employee",
                              else: "External" } }
    } },

La operación devuelve los siguientes documentos:

{ "_id" : 1, "comment" : "Hi, I'm just reading about MongoDB -- aunt.arc.tica@example.com", "category" : "External" }
{ "_id" : 2, "comment" : "I wanted to concatenate a string", "category" : "External" }
{ "_id" : 3, "comment" : "How do I convert a date to string? Contact me at either cam@mongodb.com or c.dia@mongodb.com", "category" : "Employee" }
{ "_id" : 4, "comment" : "It's just me. I'm testing.  fred@MongoDB.com", "category" : "Employee" }

Volver

$regexFindAll

$replaceOne

Definición

Sintaxis

Devuelve

Tip

Comportamiento

Coincidencia de expresiones regulares e intercalación

Ejemplos

$regexMatch y sus opciones

i Opción

Nota

m Opción

Nota

x Opción

Nota

s Opción

Nota

Utiliza $regexMatch para verificar la dirección de correo electrónico

`$regexMatch` y sus opciones

`i` Opción

`m` Opción

`x` Opción

`s` Opción

Utiliza `$regexMatch` para verificar la dirección de correo electrónico