

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

# $ percentil
<a name="percentile"></a>

Novo na versão 8.0.1.

O `$percentile` operador no Amazon DocumentDB calcula valores percentuais especificados para dados numéricos. Como acumulador, ele calcula valores percentuais em documentos dentro de um grupo no `$group` estágio de um pipeline de agregação. Como expressão, ele calcula os percentis para uma matriz de números.

**Parâmetros**
+ `input`: uma expressão que resolve para um valor numérico ou uma matriz de valores numéricos.
+ `p`: uma matriz de valores percentuais entre 0 e 1, em que cada valor representa um percentil a ser calculado. Por exemplo, `[0.25, 0.5, 0.75]` calcula os percentis 25, 50 e 75.
+ `method`: uma string especificando o método de cálculo. No momento, somente `"approximate"` é compatível.

## Comportamento
<a name="percentile-behavior"></a>

O `"approximate"` método usa o algoritmo t-digest para calcular métricas aproximadas baseadas em percentis. Com pequenos conjuntos de dados, valores percentuais distintos podem resultar no mesmo resultado. Por exemplo, com apenas 5 valores por grupo, p90 e p99 podem retornar o valor máximo no grupo. A precisão melhora à medida que o número de pontos de dados aumenta.

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

O exemplo a seguir mostra como usar o `$percentile` operador para calcular os percentis 25 e 75 de pontuações por classe.

**Crie documentos de amostra **

```
db.students.insertMany([
  { class: "A", score: 72 },
  { class: "A", score: 85 },
  { class: "A", score: 90 },
  { class: "A", score: 68 },
  { class: "A", score: 95 },
  { class: "B", score: 80 },
  { class: "B", score: 75 },
  { class: "B", score: 92 },
  { class: "B", score: 88 },
  { class: "B", score: 70 }
]);
```

**Exemplo de consulta **

```
db.students.aggregate([
  { $group: {
      _id: "$class",
      percentiles: { $percentile: { input: "$score", p: [0.25, 0.75], method: "approximate" } }
    }}
]);
```

**Saída**

```
[
  { "_id": "A", "percentiles": [72, 90] },
  { "_id": "B", "percentiles": [75, 88] }
]
```

## Exemplo de uso de expressão (MongoDB Shell)
<a name="percentile-expression-examples"></a>

O `$percentile` operador também pode ser usado como uma expressão dentro de um `$project` estágio para calcular os percentis de um campo de matriz.

**Crie documentos de amostra **

```
db.surveys.insertMany([
  { _id: 1, responses: [2, 4, 6, 8, 10, 12, 14, 16, 18, 20] },
  { _id: 2, responses: [1, 3, 5, 7, 9, 11, 13, 15, 17, 19] }
]);
```

**Exemplo de consulta **

```
db.surveys.aggregate([
  { $project: {
      quartiles: { $percentile: { input: "$responses", p: [0.25, 0.5, 0.75], method: "approximate" } }
    }}
]);
```

**Saída**

```
[
  { "_id": 1, "quartiles": [6, 10, 16] },
  { "_id": 2, "quartiles": [5, 9, 15] }
]
```

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

Para ver um exemplo de código para usar o `$percentile` operador, escolha a guia do idioma que você deseja usar. Os exemplos a seguir mostram o uso do acumulador (in`$group`) e o uso da expressão (in`$project`):

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

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

async function example() {
  const uri = 'mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false';
  const client = new MongoClient(uri);

  try {
    await client.connect();
    const db = client.db('test');

    // Accumulator usage: percentiles across grouped documents
    const students = db.collection('students');
    const accumulatorResult = await students.aggregate([
      { $group: {
          _id: "$class",
          percentiles: { $percentile: { input: "$score", p: [0.25, 0.75], method: "approximate" } }
        }}
    ]).toArray();
    console.log('Accumulator result:', accumulatorResult);

    // Expression usage: percentiles of an array field
    const surveys = db.collection('surveys');
    const expressionResult = await surveys.aggregate([
      { $project: {
          quartiles: { $percentile: { input: "$responses", p: [0.25, 0.5, 0.75], method: "approximate" } }
        }}
    ]).toArray();
    console.log('Expression result:', expressionResult);

  } finally {
    await client.close();
  }
}

example();
```

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

```
from pymongo import MongoClient

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

    try:
        db = client['test']

        # Accumulator usage: percentiles across grouped documents
        students = db['students']
        accumulator_result = list(students.aggregate([
            { '$group': {
                '_id': '$class',
                'percentiles': { '$percentile': { 'input': '$score', 'p': [0.25, 0.75], 'method': 'approximate' } }
            }}
        ]))
        print('Accumulator result:', accumulator_result)

        # Expression usage: percentiles of an array field
        surveys = db['surveys']
        expression_result = list(surveys.aggregate([
            { '$project': {
                'quartiles': { '$percentile': { 'input': '$responses', 'p': [0.25, 0.5, 0.75], 'method': 'approximate' } }
            }}
        ]))
        print('Expression result:', expression_result)

    finally:
        client.close()

example()
```

------