Docs Menu
Docs Home
/ /

db.collection.stats() (método mongosh)

MongoDB con controladores

Esta página documenta una mongosh . Para ver el método equivalente en un driver de MongoDB, se debe consultar la página correspondiente al lenguaje de programación:

C#Java SyncNode.jsPyMongoCC++GoJava RSKotlin CoroutineKotlin SyncPHPMongoidRustScala

Importante

Método mongosh

Esta página documenta un método mongosh. Esta no es la documentación para los comandos de base de datos ni para los drivers específicos de lenguajes, como Nodo.js.

Para el comando de base de datos, consulte el collStats dominio.

Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.

db.collection.stats(<option>)

Devuelve estadísticas sobre la colección.

Devuelve:Un documento que contiene estadísticas sobre la colección especificada. Se puede consultar collStats para obtener un desglose de las estadísticas devueltas.

Nota

db.collection.stats() llama internamente a la etapa de agregación $collStats por defecto.

El método tiene el siguiente formato:

db.collection.stats({
scale: <num>, // Optional
indexDetails: <boolean>, // Optional
indexDetailsKey: <document>, // Optional
indexDetailsName: <string>. // Optional
})
Campo
Tipo
Descripción

scale

Número

Opcional. El factor de escala para los datos de los distintos tamaños. El scale por defecto es 1 para devolver los datos de tamaño en bytes. Para mostrar los kilobytes en lugar de bytes, se debe especificar un valor scale de 1024.

Si se especifica un factor de escala no entero, MongoDB utiliza la parte entera del factor especificado. Por ejemplo, si se especifica un factor de escala de 1023.999, MongoDB utiliza 1023 como factor de escala.

A partir de la versión 4.2, la salida incluye el scaleFactor utilizado para escalar los valores de tamaño.

indexDetails

booleano

Opcional. Si true, db.collection.stats() devuelve index details además de las estadísticas de la colección.

Solo funciona para el motor de almacenamiento WiredTiger.

Se establece por defecto en false.

indexDetailsKey

Documento

Opcional. Si indexDetails es true, se puede usar indexDetailsKey para filtrar los detalles del índice especificando la clave del índice. Solo se devolverá el índice que coincida exactamente con indexDetailsKey.

Si no se encuentra ninguna coincidencia, indexDetails mostrará estadísticas de todos los índices.

Se puede usar getIndexes() para descubrir claves de índice. No se puede usar indexDetailsKey con indexDetailsName.

indexDetailsName

string

Opcional. Si indexDetails es true, se puede utilizar indexDetailsName para el filtro de detalles del índice especificando el índice name. Solo se devolverá el nombre de índice que coincida exactamente con indexDetailsName.

Si no se encuentra ninguna coincidencia, indexDetails mostrará estadísticas de todos los índices.

Se puede usar getIndexes() para descubrir los nombres de los índices. No se puede usar indexDetailsName con indexDetailsField.

Para especificar solo el factor scale, MongoDB admite el formato heredado:

db.collection.stats(<number>)

Este método está disponible en implementaciones alojadas en los siguientes entornos:

  • MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Nota

Este comando es compatible con todos los clústeres de MongoDB Atlas. Para obtener información sobre el soporte de Atlas para todos los comandos, consulte Comandos no compatibles.

  • MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

  • MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

A menos que el nombre de la métrica lo especifique (como "bytes currently in the cache"), los valores relacionados con el tamaño se muestran en bytes y pueden ser anulados por scale.

El factor de escala redondea los valores de tamaño afectados a números enteros.

Según el motor de almacenamiento, los datos devueltos pueden diferir. Para obtener más información sobre los campos, se puede consultar detalles de salida.

Después de un cierre no limpio de un mongod que utiliza el motor de almacenamiento WiredTiger, las estadísticas de conteo y tamaño informadas por db.collection.stats() pueden ser inexactas.

La cantidad de deriva depende del número de operaciones de inserción, actualización o eliminación realizadas entre el último punto de control y el apagado no limpio. Los puntos de control suelen ocurrir cada 60 segundos. Sin embargo, las instancias mongod que se ejecutan con configuraciones --syncdelay no por defecto pueden tener puntos de control más o menos frecuentes.

Ejecuta validate en cada colección en el mongod para restaurar las estadísticas después de un apagado no limpio.

Después de un apagado no limpio:

Para que se ejecuten en un set de réplicas, las operaciones de collStats requieren que el nodo esté en estado PRIMARY o SECONDARY. Si el nodo se encuentra en otro estado, como STARTUP2, se produce un error en la operación.

Filtrar por indexDetails utilizando indexDetailsKey o indexDetailsName solo devolverá un único índice coincidente. Si no se encuentra una coincidencia exacta, indexDetails mostrará información sobre todos los índices de la colección.

El campo indexDetailsKey acepta un documento con el siguiente formato:

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

Donde <string>> es el campo que está indexado y <value> es la dirección del índice o el tipo de índice especial, como text o 2dsphere. Consulta los tipos de índice para ver la lista completa de los tipos de índice.

A partir de MongoDB 8.0, utiliza la configuración del query en lugar de añadir filtros de índice. Los filtros de índices están en desuso a partir de MongoDB 8.0.

La configuración de queries tiene más funcionalidades que los filtros de índices. Además, los filtros de índice no son persistentes y no puedes crear fácilmente filtros de índice para todos los nodos del clúster. Para añadir ajustes de query y explorar ejemplos, consulta setQuerySettings.

Para las instancias de MongoDB que utilizan el motor de almacenamiento WiredTiger, después de un apagado no limpio, las estadísticas de tamaño y conteo pueden diferir hasta en 1000 documentos según lo informado por collStats, dbStats, count. Para efectuar la restauración de las estadísticas correctas para la colección, se debe ejecutar validate en la colección.

La db.collection.stats() incluye información sobre los índices que se están compilando actualmente. Para obtener más detalles, se puede consultar:

La siguiente operación devuelve estadísticas de la colección de restaurants en la base de datos test:

db.restaurants.stats()

La operación arroja:

{
"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 las estadísticas no indicaban un parámetro de escala, todos los valores de tamaño están en bytes.

La siguiente operación cambia el escalado de datos de bytes a kilobytes especificando un scale de 1024:

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

La operación arroja:

{
"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
}

La siguiente operación crea un documento indexDetails que contiene información relacionada con cada uno de los índices de la colección:

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

La operación arroja:

{
"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
}

Para filtrar los índices en el campo indexDetails, se pueden especificar las claves del índice utilizando la opción indexDetailsKey o especificar el nombre del índice mediante indexDetailsName. Para descubrir claves de índice y nombres para la colección, se puede utilizar db.collection.getIndexes().

Dado el siguiente índice:

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

La siguiente operación filtra el documento indexDetails a un solo índice según lo definido por el documento indexDetailsKey.

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

La siguiente operación filtra el documento indexDetails a un solo índice según lo definido por el documento indexDetailsName.

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

Ambas operaciones devolverán el mismo resultado:

{
"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 obtener una explicación de la salida, se puede consultar detalles de salida.

Tip

Volver

db.collection.replaceOne

En esta página