As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# \$1regexMatch
<a name="regexMatch"></a>

Novo a partir da versão 5.0. Não é compatível com o cluster elástico.

O `$regexMatch` operador no Amazon DocumentDB é usado para realizar a correspondência de expressões regulares em campos de string. Ele retorna um valor booleano (`true`ou`false`) indicando se a string de entrada corresponde ao padrão especificado.

**Parâmetros**
+ `input`: a string a ser testada em relação à expressão regular.
+ `regex`: O padrão de expressão regular a ser correspondente.
+ `options`: (Opcional) Sinalizadores para modificar o comportamento da expressão regular, como correspondência sem distinção entre maiúsculas e minúsculas (`i`) ou correspondência de várias linhas (). `m`

## Exemplo (MongoDB Shell)
<a name="regexMatch-examples"></a>

O exemplo a seguir demonstra como usar o `$regexMatch` operador para verificar se os nomes começam com a letra 'M'. O operador retorna `true` ou `false` para cada documento.

**Crie documentos de amostra**

```
db.users.insertMany([
  { "_id":1, name: "María García", email: "maría@example.com" },
  { "_id":2, name: "Arnav Desai", email: "arnav@example.com" },
  { "_id":3, name: "Martha Rivera", email: "martha@example.com" },
  { "_id":4, name: "Richard Roe", email: "richard@example.com" },

]);
```

**Exemplo de consulta**

```
db.users.aggregate([
  {
    $project: {
      name: 1,
      startsWithM: {
        $regexMatch: {
          input: "$name",
          regex: "^M",
          options: "i"
        }
      }
    }
  }
]);
```

**Saída**

```
{ _id: 1, name: 'María García', startsWithM: true },
{ _id: 2, name: 'Arnav Desai', startsWithM: false },
{ _id: 3, name: 'Martha Rivera', startsWithM: true },
{ _id: 4, name: 'Richard Roe', startsWithM: false }
```

## Exemplos de código
<a name="regexMatch-code"></a>

Para ver um exemplo de código para usar o `$regexMatch` comando, escolha a guia do idioma que você deseja usar:

------
#### [ Node.js ]

```
const { MongoClient } = require('mongodb');

async function checkNamePattern() {
  const client = await MongoClient.connect('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false');
  const db = client.db('test');
  const collection = db.collection('users');

  const result = await collection.aggregate([
    {
      $project: {
        name: 1,
        startsWithM: {
          $regexMatch: {
            input: "$name",
            regex: "^M",
            options: "i"
          }
        }
      }
    }
  ]).toArray();

  console.log(result);

  await client.close();
}

checkNamePattern();
```

------
#### [ Python ]

```
from pymongo import MongoClient

def check_name_pattern():
    client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false')
    db = client.test
    collection = db.users

    result = list(collection.aggregate([
        {
            '$project': {
                'name': 1,
                'startsWithM': {
                    '$regexMatch': {
                        'input': '$name',
                        'regex': '^M',
                        'options': 'i'
                    }
                }
            }
        }
    ]))

    print(result)

    client.close()

check_name_pattern()
```

------