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

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

Novo a partir da versão 4.0

O estágio `$collStats` de agregação no Amazon DocumentDB fornece estatísticas sobre a coleção especificada, semelhante ao comando `db.collection.stats()` no shell do MongoDB. Esse estágio pode ser usado para recuperar informações sobre a coleção, como o número de documentos, o tamanho total da coleção e várias métricas de desempenho.

**Parâmetros**
+ `latencyStats`: (opcional) Um documento que especifica as opções para coletar estatísticas de latência. Esse parâmetro não é suportado no Amazon DocumentDB.
+ `recordStats`: (opcional) Um documento que especifica as opções para coletar estatísticas de registros. Esse parâmetro não é suportado no Amazon DocumentDB.
+ `queryExecStats`: (opcional) Um documento que especifica as opções para coletar estatísticas de execução da consulta. Esse parâmetro não é suportado no Amazon DocumentDB.

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

O exemplo a seguir demonstra como usar o estágio de `$collStats` agregação para recuperar estatísticas sobre uma coleção nomeada `test` no banco de dados. `db`

**Crie documentos de amostra**

```
db.test.insertMany([
  { "name": "John", "age": 30 },
  { "name": "Jane", "age": 25 },
  { "name": "Bob", "age": 35 }
]);
```

**Exemplo de consulta**

```
db.test.aggregate([
  { $collStats: {} }
]);
```

**Saída**

```
{
  "ns" : "db.test",
  "count" : 3,
  "size" : 87,
  "avgObjSize" : 29,
  "storageSize" : 40960,
  "capped" : false,
  "nindexes" : 1,
  "totalIndexSize" : 8192,
  "indexSizes" : {
    "_id_" : 8192
  },
  "collScans" : 0,
  "idxScans" : 0,
  "opCounter" : {
    "numDocsIns" : 3,
    "numDocsUpd" : 0,
    "numDocsDel" : 0
  },
  "cacheStats" : {
    "collBlksHit" : 0,
    "collBlksRead" : 0,
    "collHitRatio" : 0,
    "idxBlksHit" : 0,
    "idxBlksRead" : 0,
    "idxHitRatio" : 0
  },
  "lastReset" : "2023-04-11T12:00:00Z",
  "ok" : 1,
  "operationTime" : Timestamp(1681206000, 1)
}
```

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

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

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

Aqui está um exemplo de como usar o estágio de `$collStats` agregação em um aplicativo Node.js usando o driver oficial do MongoDB Node.js:

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

async function runCollStatsExample() {
  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('db');
  const collection = db.collection('test');

  const result = await collection.aggregate([
    { $collStats: {} }
  ]).toArray();

  console.log(result);

  await client.close();
}

runCollStatsExample();
```

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

Aqui está um exemplo de como usar o estágio de `$collStats` agregação em um aplicativo Python usando o PyMongo driver:

```
from pymongo import MongoClient

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

    result = list(collection.aggregate([
        { '$collStats': {} }
    ]))

    print(result)

    client.close()

run_coll_stats_example()
```

------