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á.

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

Novo a partir da versão 4.0.

Não é compatível com o cluster elástico.

O `$jsonSchema` operador no Amazon DocumentDB é usado para filtrar documentos com base em um esquema JSON especificado. Esse operador permite que você consulte documentos que correspondam a um esquema JSON específico, garantindo que os documentos recuperados atendam aos requisitos estruturais e de tipo de dados específicos.

Usando o operador de consulta de `$jsonSchema` avaliação como parte da criação de uma coleção, você pode validar o esquema dos documentos que estão sendo inseridos na coleção. Para obter informações adicionais, consulte [Usando a validação do esquema JSON](json-schema-validation.md).

**Parâmetros**
+ `required`(matriz): especifica os campos obrigatórios no documento.
+ `properties`(objeto): define o tipo de dados e outras restrições para cada campo no documento.

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

O exemplo a seguir demonstra o uso do `$jsonSchema` operador para filtrar a `employees` coleção para recuperar somente documentos que tenham os `age` campos`name`, `employeeId` e, e o `employeeId` campo seja do tipo. `string`

**Crie documentos de amostra**

```
db.employees.insertMany([
  { "name": { "firstName": "Carol", "lastName": "Smith" }, "employeeId": "1" },
  { "name": { "firstName": "Emily", "lastName": "Brown" }, "employeeId": "2", "age": 25 },
  { "name": { "firstName": "William", "lastName": "Taylor" }, "employeeId": 3, "age": 24 },
  { "name": { "firstName": "Jane", "lastName": "Doe" }, "employeeId": "4" }
]);
```

**Exemplo de consulta**

```
db.employees.aggregate([
  { $match: {
    $jsonSchema: {
      required: ["name", "employeeId", "age"],
      properties: { "employeeId": { "bsonType": "string" } }
    }
  }}
]);
```

**Saída**

```
{ "_id" : ObjectId("6908e8b61f77fc26b2ecd26f"), "name" : { "firstName" : "Emily", "lastName" : "Brown" }, "employeeId" : "2", "age" : 25 }
```

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

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

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

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

async function filterByJsonSchema() {
  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('employees');

  const result = await collection.aggregate([
    {
      $match: {
        $jsonSchema: {
          required: ['name', 'employeeId', 'age'],
          properties: { 'employeeId': { 'bsonType': 'string' } }
        }
      }
    }
  ]).toArray();

  console.log(result);
  await client.close();
}

filterByJsonSchema();
```

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

```
from pymongo import MongoClient

def filter_by_json_schema():
  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['employees']

  result = list(collection.aggregate([
    {
      '$match': {
        '$jsonSchema': {
          'required': ['name', 'employeeId', 'age'],
          'properties': {'employeeId': {'bsonType': 'string'}}
        }
      }
    }
  ]))

  print(result)
  client.close()

filter_by_json_schema()
```

------