Menu Docs
Página inicial do Docs
/
Manual do MongoDB
/
Referência
/
Métodos de mongosh
/
Métodos de collection

db.collection.stats()

Nesta página

  • Definição
  • Comportamento
  • Exemplos

Definição

Use o estágio de aggregation $collStats em vez do comando collStats e seu método auxiliar mongosh db.collection.stats().

db.collection.stats(<option>)

Importante

Método mongosh

Esta página documenta um método mongosh . Esta não é a documentação para comandos de banco de dados ou drivers específicos de idioma, como Node.js.

Para o comando do banco de dados, consulte o comando collStats.

Para drivers de API do MongoDB, consulte a documentação do driver MongoDB específica do idioma.

Para a documentação de shell legada do mongo, consulte a documentação para a versão correspondente do MongoDB Server:

mongo shell v4.4

Retorna estatísticas sobre a coleção.

O método tem o seguinte formato:

db.collection.stats({
   scale: <num>,                   // Optional
   indexDetails: <boolean>,        // Optional
   indexDetailsKey: <document>,    // Optional
   indexDetailsName: <string>.     // Optional
})
Campo
Tipo
Descrição
scale
número

Opcional. O fator de escala para os dados de vários tamanhos. O padrão scale é 1 para retornar dados de tamanho em bytes. Para exibir kilobytes em vez de bytes, especifique um valor scale de 1024.

Se você especificar um fator de escala não inteiro, o MongoDB utilizará a parte inteira do fator especificado. Por exemplo, se você especificar um fator de escala de 1023.999, MongoDB utilizará 1023 como o fator de escala.

A partir da versão 4.2, a saída inclui o scaleFactor utilizado para dimensionar os valores de tamanho.

indexDetails
booleano

Opcional. Se true, db.collection.stats() retornará index details além das estatísticas da coleção.

Funciona apenas para o mecanismo de armazenamento WiredTiger.

Padrão é false.

indexDetailsKey
documento

Opcional. Se indexDetails for true, você pode usar indexDetailsKey para filtrar detalhes do índice especificando a especificação da chave do índice. Somente o índice que corresponde exatamente a indexDetailsKey será retornado.

Se nenhuma correspondência for encontrada, indexDetails exibirá as estatísticas de todos os índices.

Use getIndexes() para descobrir chaves de índice. Você não pode usar indexDetailsKey com indexDetailsName.

indexDetailsName
string

Opcional. Se indexDetails for true, você pode utilizar indexDetailsName para filtrar detalhes do índice especificando o índice name. Somente o nome do índice que corresponde exatamente a indexDetailsName será retornado.

Se nenhuma correspondência for encontrada, indexDetails exibirá as estatísticas de todos os índices.

Use o getIndexes() para descobrir nomes de índice. Você não pode usar indexDetailsName com indexDetailsField.

Para especificar apenas o fator scale, o MongoDB suporta o formato legado:

db.collection.stats(<number>)
Retorna:Um documento que contém estatísticas sobre a coleção especificada. Consulte collStats para um detalhamento das estatísticas retornadas.

Comportamento

Tamanhos em escala

A menos que especificado de outra forma pelo nome da métrica (como "bytes currently in the cache"), os valores relacionados ao tamanho são exibidos em bytes e podem ser substituídos por scale.

O fator de escala arredonda os valores de tamanho afetados para números inteiros.

Mecanismo de armazenamento

Dependendo do mecanismo de armazenamento, os dados retornados podem ser diferentes. Para obter detalhes sobre os campos, consulte detalhes de saída.

Precisão após Desligamento Inesperado

Depois de um desligamento impróprio de um mongod usando o mecanismo de armazenamento Wired Tiger , as estatísticas de contagem e tamanho informadas pelo db.collection.stats() podem ser imprecisas.

A quantidade de desvio depende do número de operações de inserção, atualização ou exclusão executadas entre o último ponto de verificação e o desligamento não limpo. Os pontos de verificação geralmente ocorrem a cada 60 segundos. No entanto, mongod instâncias executadas com configurações de --syncdelay não padrão podem ter pontos de verificação mais ou menos frequentes.

Execute validate em cada collection no mongod para restaurar as estatísticas depois de um desligamento impróprio.

Após um desligamento impróprio:

Restrição de estado do membro do conjunto de réplica

Para executar em um membro do conjunto de réplica, as operações do collStats exigem que o membro esteja no estado PRIMARY ou SECONDARY . Se o membro estiver em outro estado, como STARTUP2, os erros de operação.

Comportamento do filtro de índice

A filtragem em indexDetails usando indexDetailsKey ou indexDetailsName retornará apenas um único índice correspondente. Se nenhuma correspondência exata for encontrada, indexDetails mostrará informações sobre todos os índices da coleção.

O campo indexDetailsKey obtém um documento do seguinte formulário:

{ '<string>' : <value>, '<string>' : <value>, ... }

Em que <string>> é o campo indexado e <value> é a direção do índice ou o tipo de índice especial, como text ou 2dsphere. Consulte tipos de índice para obter a lista completa de tipos de índice.

Desligamento e contagem inesperados

Para instâncias do MongoDB usando o mecanismo de armazenamento WiredTiger , após um desligamento impuro, as estatísticas sobre tamanho e contagem podem diminuir em até 1000 documentos, conforme relatado por collStats, dbStats, count. Para restaurar as estatísticas corretas para a coleção, execute o validate na coleção.

Índices em andamento

O db.collection.stats() inclui informações sobre índices atualmente sendo construídos. Para obter detalhes, consulte:

Exemplos

Observação

Você pode encontrar os dados de collection usados para esses exemplos em nosso primer-dataset.json

Pesquisa básica de estatísticas

A seguinte operação retorna estatísticas na coleção restaurants no banco de dados test:

db.restaurants.stats()

A operação retorna:

{
   "ns" : "test.restaurants",
   "size" : 7557340,
   "count" : 25359,
   "avgObjSize" : 298,
   "storageSize" : 9670656,
   "freeStorageSize" : 6660096,
   "capped" : false,
   "wiredTiger" : {
         "metadata" : {
            "formatVersion" : 1
         },
         "creationString" : "access_pattern_hint=none,allocation_size=4KB,app_metadata=(formatVersion=1),assert=(commit_timestamp=none,durable_timestamp=none,read_timestamp=none),block_allocation=best,block_compressor=snappy,cache_resident=false,checksum=on,colgroups=,collator=,columns=,dictionary=0,encryption=(keyid=,name=),exclusive=false,extractor=,format=btree,huffman_key=,huffman_value=,ignore_in_memory_cache_size=false,immutable=false,internal_item_max=0,internal_key_max=0,internal_key_truncate=true,internal_page_max=4KB,key_format=q,key_gap=10,leaf_item_max=0,leaf_key_max=0,leaf_page_max=32KB,leaf_value_max=64MB,log=(enabled=true),lsm=(auto_throttle=true,bloom=true,bloom_bit_count=16,bloom_config=,bloom_hash_count=8,bloom_oldest=false,chunk_count_limit=0,chunk_max=5GB,chunk_size=10MB,merge_custom=(prefix=,start_generation=0,suffix=),merge_max=15,merge_min=0),memory_page_image_max=0,memory_page_max=10m,os_cache_dirty_max=0,os_cache_max=0,prefix_compression=false,prefix_compression_min=4,source=,split_deepen_min_child=0,split_deepen_per_child=0,split_pct=90,type=file,value_format=u",
         "type" : "file",
         "uri" : "statistics:table:collection-43-6797839137631957852",
         "LSM" : {
            "bloom filter false positives" : 0,
            "bloom filter hits" : 0,
            "bloom filter misses" : 0,
            "bloom filter pages evicted from cache" : 0,
            "bloom filter pages read into cache" : 0,
            "bloom filters in the LSM tree" : 0,
            "chunks in the LSM tree" : 0,
            "highest merge generation in the LSM tree" : 0,
            "queries that could have benefited from a Bloom filter that did not exist" : 0,
            "sleep for LSM checkpoint throttle" : 0,
            "sleep for LSM merge throttle" : 0,
            "total size of bloom filters" : 0
         },
         "block-manager" : {
            "allocations requiring file extension" : 460,
            "blocks allocated" : 556,
            "blocks freed" : 420,
            "checkpoint size" : 2994176,
            "file allocation unit size" : 4096,
            "file bytes available for reuse" : 6660096,
            "file magic number" : 120897,
            "file major version number" : 1,
            "file size in bytes" : 9670656,
            "minor version number" : 0
         },
         "btree" : {
            "btree checkpoint generation" : 58,
            "column-store fixed-size leaf pages" : 0,
            "column-store internal pages" : 0,
            "column-store variable-size RLE encoded values" : 0,
            "column-store variable-size deleted values" : 0,
            "column-store variable-size leaf pages" : 0,
            "fixed-record size" : 0,
            "maximum internal page key size" : 368,
            "maximum internal page size" : 4096,
            "maximum leaf page key size" : 2867,
            "maximum leaf page size" : 32768,
            "maximum leaf page value size" : 67108864,
            "maximum tree depth" : 3,
            "number of key/value pairs" : 0,
            "overflow pages" : 0,
            "pages rewritten by compaction" : 0,
            "row-store empty values" : 0,
            "row-store internal pages" : 0,
            "row-store leaf pages" : 0
         },
         "cache" : {
            "bytes currently in the cache" : 19401033,
            "bytes dirty in the cache cumulative" : 28415209,
            "bytes read into cache" : 0,
            "bytes written from cache" : 31893695,
            "checkpoint blocked page eviction" : 0,
            "data source pages selected for eviction unable to be evicted" : 0,
            "eviction walk passes of a file" : 0,
            "eviction walk target pages histogram - 0-9" : 0,
            "eviction walk target pages histogram - 10-31" : 0,
            "eviction walk target pages histogram - 128 and higher" : 0,
            "eviction walk target pages histogram - 32-63" : 0,
            "eviction walk target pages histogram - 64-128" : 0,
            "eviction walks abandoned" : 0,
            "eviction walks gave up because they restarted their walk twice" : 0,
            "eviction walks gave up because they saw too many pages and found no candidates" : 0,
            "eviction walks gave up because they saw too many pages and found too few candidates" : 0,
            "eviction walks reached end of tree" : 0,
            "eviction walks started from root of tree" : 0,
            "eviction walks started from saved location in tree" : 0,
            "hazard pointer blocked page eviction" : 0,
            "in-memory page passed criteria to be split" : 4,
            "in-memory page splits" : 2,
            "internal pages evicted" : 0,
            "internal pages split during eviction" : 0,
            "leaf pages split during eviction" : 2,
            "modified pages evicted" : 2,
            "overflow pages read into cache" : 0,
            "page split during eviction deepened the tree" : 0,
            "page written requiring cache overflow records" : 0,
            "pages read into cache" : 0,
            "pages read into cache after truncate" : 1,
            "pages read into cache after truncate in prepare state" : 0,
            "pages read into cache requiring cache overflow entries" : 0,
            "pages requested from the cache" : 76607,
            "pages seen by eviction walk" : 0,
            "pages written from cache" : 552,
            "pages written requiring in-memory restoration" : 0,
            "tracked dirty bytes in the cache" : 0,
            "unmodified pages evicted" : 0
         },
         "cache_walk" : {
            "Average difference between current eviction generation when the page was last considered" : 0,
            "Average on-disk page image size seen" : 0,
            "Average time in cache for pages that have been visited by the eviction server" : 0,
            "Average time in cache for pages that have not been visited by the eviction server" : 0,
            "Clean pages currently in cache" : 0,
            "Current eviction generation" : 0,
            "Dirty pages currently in cache" : 0,
            "Entries in the root page" : 0,
            "Internal pages currently in cache" : 0,
            "Leaf pages currently in cache" : 0,
            "Maximum difference between current eviction generation when the page was last considered" : 0,
            "Maximum page size seen" : 0,
            "Minimum on-disk page image size seen" : 0,
            "Number of pages never visited by eviction server" : 0,
            "On-disk page image sizes smaller than a single allocation unit" : 0,
            "Pages created in memory and never written" : 0,
            "Pages currently queued for eviction" : 0,
            "Pages that could not be queued for eviction" : 0,
            "Refs skipped during cache traversal" : 0,
            "Size of the root page" : 0,
            "Total number of pages currently in cache" : 0
         },
         "compression" : {
            "compressed page maximum internal page size prior to compression" : 4096,
            "compressed page maximum leaf page size prior to compression " : 111392,
            "compressed pages read" : 0,
            "compressed pages written" : 548,
            "page written failed to compress" : 0,
            "page written was too small to compress" : 4
         },
         "cursor" : {
            "bulk loaded cursor insert calls" : 0,
            "cache cursors reuse count" : 74,
            "close calls that result in cache" : 0,
            "create calls" : 4,
            "insert calls" : 50718,
            "insert key and value bytes" : 24500283,
            "modify" : 0,
            "modify key and value bytes affected" : 0,
            "modify value bytes modified" : 0,
            "next calls" : 101747,
            "open cursor count" : 0,
            "operation restarted" : 0,
            "prev calls" : 1,
            "remove calls" : 0,
            "remove key bytes removed" : 0,
            "reserve calls" : 0,
            "reset calls" : 51000,
            "search calls" : 25359,
            "search near calls" : 25485,
            "truncate calls" : 0,
            "update calls" : 0,
            "update key and value bytes" : 0,
            "update value size change" : 0
         },
         "reconciliation" : {
            "dictionary matches" : 0,
            "fast-path pages deleted" : 0,
            "internal page key bytes discarded using suffix compression" : 1077,
            "internal page multi-block writes" : 1,
            "internal-page overflow keys" : 0,
            "leaf page key bytes discarded using prefix compression" : 0,
            "leaf page multi-block writes" : 12,
            "leaf-page overflow keys" : 0,
            "maximum blocks required for a page" : 1,
            "overflow values written" : 0,
            "page checksum matches" : 0,
            "page reconciliation calls" : 80,
            "page reconciliation calls for eviction" : 2,
            "pages deleted" : 0
         },
         "session" : {
            "object compaction" : 0
         },
         "transaction" : {
            "update conflicts" : 0
         }
   },
   "nindexes" : 4,
   "indexBuilds" : [ ],
   "totalIndexSize" : 704512,
   "totalSize" : 10375168,
   "indexSizes" : {
      "_id_" : 241664,
      "cuisine_1" : 147456,
      "borough_1_cuisine_1" : 159744,
      "borough_1_address.zipcode_1" : 155648
   },
   "scaleFactor" : 1,
   "ok" : 1
}

Como as estatísticas não receberam um parâmetro de escala, todos os valores de tamanho estão em bytes.

Pesquisa de estatísticas com escala

A seguinte operação altera a escala de dados de bytes para kilobytes especificando um scale de 1024:

db.restaurants.stats( { scale : 1024 } )

A operação retorna:

{
   "ns" : "test.restaurants",
   "size" : 7380,
   "count" : 25359,
   "avgObjSize" : 298,
   "storageSize" : 9444,
   "freeStorageSize" : 6504,
   "capped" : false,
   "wiredTiger" : {
      ...
   },
   "nindexes" : 4,
   "indexBuilds" : [ ],
   "totalIndexSize" : 688,
   "totalSize" : 10132,
   "indexSizes" : {
      "_id_" : 236,
      "cuisine_1" : 144,
      "borough_1_cuisine_1" : 156,
      "borough_1_address.zipcode_1" : 152
   },
   "scaleFactor" : 1024,
   "ok" : 1
}

Pesquisa de estatísticas com detalhes do índice

A seguinte operação cria um documento indexDetails que contém informações relacionadas a cada um dos índices dentro da coleção:

db.restaurants.stats( { indexDetails : true } )

A operação retorna:

{
   "ns" : "test.restaurants",
   "size" : 7557340,
   "count" : 25359,
   "avgObjSize" : 298,
   "storageSize" : 9670656,
   "freeStorageSize" : 6660096,
   "capped" : false,
   "wiredTiger" : {
   ...
   },
   "nindexes" : 4,
   "indexDetails" : {
      "_id_" : {
         "metadata" : {
            "formatVersion" : 8
         },
         "creationString" : "access_pattern_hint=none,allocation_size=4KB,app_metadata=(formatVersion=8),assert=(commit_timestamp=none,durable_timestamp=none,read_timestamp=none),block_allocation=best,block_compressor=,cache_resident=false,checksum=on,colgroups=,collator=,columns=,dictionary=0,encryption=(keyid=,name=),exclusive=false,extractor=,format=btree,huffman_key=,huffman_value=,ignore_in_memory_cache_size=false,immutable=false,internal_item_max=0,internal_key_max=0,internal_key_truncate=true,internal_page_max=16k,key_format=u,key_gap=10,leaf_item_max=0,leaf_key_max=0,leaf_page_max=16k,leaf_value_max=0,log=(enabled=true),lsm=(auto_throttle=true,bloom=true,bloom_bit_count=16,bloom_config=,bloom_hash_count=8,bloom_oldest=false,chunk_count_limit=0,chunk_max=5GB,chunk_size=10MB,merge_custom=(prefix=,start_generation=0,suffix=),merge_max=15,merge_min=0),memory_page_image_max=0,memory_page_max=5MB,os_cache_dirty_max=0,os_cache_max=0,prefix_compression=true,prefix_compression_min=4,source=,split_deepen_min_child=0,split_deepen_per_child=0,split_pct=90,type=file,value_format=u",
         "type" : "file",
         "uri" : "statistics:table:index-44-6797839137631957852",
         "LSM" : {
         ...
         },
         "block-manager" : {
         ...
         },
         "btree" : {
         ...
         },
         "cache" : {
         ...
         },
         "cache_walk" : {
         ...
         },
         "compression" : {
         ...
         },
         "cursor" : {
         ...
         },
         "reconciliation" : {
         ...
         },
         "session" : {
         ...
         },
         "transaction" : {
         ...
         }
      },
      "cuisine_1" : {
         ...
      },
      "borough_1_cuisine_1" : {
         ...
      },
      "borough_1_address.zipcode_1" : {
         ...
   },
   "indexBuilds" : [ ],
   "totalIndexSize" : 704512,
   "totalSize" : 10375168,
   "indexSizes" : {
      "_id_" : 241664,
      "cuisine_1" : 147456,
      "borough_1_cuisine_1" : 159744,
      "borough_1_address.zipcode_1" : 155648
   },
   "scaleFactor" : 1,
   "ok" : 1
}

Pesquisa de estatísticas com detalhes de índice filtrados

Para filtrar os índices no campo indexDetails , você pode especificar as chaves de índice utilizando a opção indexDetailsKey ou especificar o nome do índice utilizando o indexDetailsName. Para descobrir as chaves de índice e nomes da coleção, utilize db.collection.getIndexes().

Considerando o seguinte índice:

{
   "ns" : "test.restaurants",
   "v" : 1,
   "key" : {
      "borough" : 1,
      "cuisine" : 1
   },
   "name" : "borough_1_cuisine_1"
}

A operação a seguir filtra o documento indexDetails para um único índice, conforme definido pelo documento indexDetailsKey.

db.restaurants.stats(
   {
      'indexDetails' : true,
      'indexDetailsKey' :
      {
         'borough' : 1,
         'cuisine' : 1
      }
   }
)

A operação a seguir filtra o documento indexDetails para um único índice, conforme definido pelo documento indexDetailsName.

db.restaurants.stats(
   {
      'indexDetails' : true,
      'indexDetailsName' : 'borough_1_cuisine_1'
   }
)

Ambas as operações retornarão a mesma saída:

{
   "ns" : "test.restaurants",
   "size" : 7557340,
   "count" : 25359,
   "avgObjSize" : 298,
   "storageSize" : 9670656,
   "freeStorageSize" : 6660096,
   "capped" : false,
   "wiredTiger" : {
      ...
   },
   "nindexes" : 4,
   "indexDetails" : {
      "borough_1_cuisine_1" : {
         "metadata" : {
            "formatVersion" : 8
         },
         "LSM" : {
            ...
         },
         "block-manager" : {
            ...
         },
         "btree" : {
            ...
         },
         "cache" : {
            ...
         },
         "cache_walk" : {
            ...
         },
         "compression" : {
            ...
         },
         "cursor" : {
            ...
         },
         "reconciliation" : {
            ...
         },
         "session" : {
            ...
         },
         "transaction" : {
            ...
         }
      }
   },
   "indexBuilds" : [ ],
   "totalIndexSize" : 704512,
   "totalSize" : 10375168,
   "indexSizes" : {
      "_id_" : 241664,
      "cuisine_1" : 147456,
      "borough_1_cuisine_1" : 159744,
      "borough_1_address.zipcode_1" : 155648
   },
   "scaleFactor" : 1,
   "ok" : 1
}

Para obter uma explicação sobre a saída, consulte os detalhes da saída.

Dica

Veja também:

$collStats

← db.collection.replaceOne()
db.collection.storageSize() →

Nesta página