-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathCollStats.html
46 lines (46 loc) · 37.1 KB
/
CollStats.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CollStats | mongodb</title><meta name="description" content="Documentation for mongodb"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">mongodb</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mongodb</a></li><li><a href="CollStats.html">CollStats</a></li></ul><h1>Interface CollStats</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>the <code>collStats</code> operation will be removed in the next major release. Please
use an aggregation pipeline with the <a href="https://www.mongodb.com/docs/manual/reference/operator/aggregation/collStats/"><code>$collStats</code></a> stage instead</p>
</dd><dt>see</dt><dd><p><a href="https://www.mongodb.com/docs/manual/reference/command/collStats/">https://www.mongodb.com/docs/manual/reference/command/collStats/</a></p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><ul class="tsd-hierarchy"><li><span class="target">CollStats</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#avgObjSize" class="tsd-kind-icon">avg<wbr/>Obj<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#capped" class="tsd-kind-icon">capped</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#count" class="tsd-kind-icon">count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#freeStorageSize" class="tsd-kind-icon">free<wbr/>Storage<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#indexBuilds" class="tsd-kind-icon">index<wbr/>Builds</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#indexDetails" class="tsd-kind-icon">index<wbr/>Details</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#indexSizes" class="tsd-kind-icon">index<wbr/>Sizes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#lastExtentSize" class="tsd-kind-icon">last<wbr/>Extent<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#max" class="tsd-kind-icon">max</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#maxSize" class="tsd-kind-icon">max<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#nindexes" class="tsd-kind-icon">nindexes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#ns" class="tsd-kind-icon">ns</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#numExtents" class="tsd-kind-icon">num<wbr/>Extents</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#ok" class="tsd-kind-icon">ok</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#paddingFactor" class="tsd-kind-icon">padding<wbr/>Factor</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#scaleFactor" class="tsd-kind-icon">scale<wbr/>Factor</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#size" class="tsd-kind-icon">size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#storageSize" class="tsd-kind-icon">storage<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#totalIndexSize" class="tsd-kind-icon">total<wbr/>Index<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#totalSize" class="tsd-kind-icon">total<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#userFlags" class="tsd-kind-icon">user<wbr/>Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#wiredTiger" class="tsd-kind-icon">wired<wbr/>Tiger</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="avgObjSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">avg<wbr/>Obj<wbr/>Size<a href="#avgObjSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">avg<wbr/>Obj<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L97">src/operations/stats.ts:97</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Average object size in bytes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="capped" class="tsd-anchor"></a><h3 class="tsd-anchor-link">capped<a href="#capped" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">capped<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L118">src/operations/stats.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p><code>true</code> if the collection is capped</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="count" class="tsd-anchor"></a><h3 class="tsd-anchor-link">count<a href="#count" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L93">src/operations/stats.ts:93</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Number of documents</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="freeStorageSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> free<wbr/>Storage<wbr/>Size<a href="#freeStorageSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">free<wbr/>Storage<wbr/>Size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L130">src/operations/stats.ts:130</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The amount of storage available for reuse. The scale argument affects this value.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="indexBuilds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> index<wbr/>Builds<a href="#indexBuilds" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">index<wbr/>Builds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L132">src/operations/stats.ts:132</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>An array that contains the names of the indexes that are currently being built on the collection</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="indexDetails" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> index<wbr/>Details<a href="#indexDetails" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">index<wbr/>Details<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L126">src/operations/stats.ts:126</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The fields in this document are the names of the indexes, while the values themselves are documents that contain statistics for the index provided by the storage engine</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="indexSizes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">index<wbr/>Sizes<a href="#indexSizes" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">index<wbr/>Sizes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>_id_<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L113">src/operations/stats.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Size of specific indexes in bytes</p>
</div></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>index: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>_id_<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="lastExtentSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">last<wbr/>Extent<wbr/>Size<a href="#lastExtentSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">last<wbr/>Extent<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L105">src/operations/stats.ts:105</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Size of the most recently created extent in bytes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="max" class="tsd-anchor"></a><h3 class="tsd-anchor-link">max<a href="#max" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L120">src/operations/stats.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum number of documents that may be present in a capped collection</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="maxSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">max<wbr/>Size<a href="#maxSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">max<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L122">src/operations/stats.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum size of a capped collection</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="nindexes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">nindexes<a href="#nindexes" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">nindexes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L103">src/operations/stats.ts:103</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Number of indexes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ns" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ns<a href="#ns" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ns<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L91">src/operations/stats.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Namespace</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="numExtents" class="tsd-anchor"></a><h3 class="tsd-anchor-link">num<wbr/>Extents<a href="#numExtents" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">num<wbr/>Extents<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L101">src/operations/stats.ts:101</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Number of extents (contiguously allocated chunks of datafile space)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ok" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ok<a href="#ok" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ok<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L127">src/operations/stats.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="paddingFactor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">padding<wbr/>Factor<a href="#paddingFactor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">padding<wbr/>Factor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L107">src/operations/stats.ts:107</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Padding can speed up updates if documents grow</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="scaleFactor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">scale<wbr/>Factor<a href="#scaleFactor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">scale<wbr/>Factor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L136">src/operations/stats.ts:136</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The scale value used by the command.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="size" class="tsd-anchor"></a><h3 class="tsd-anchor-link">size<a href="#size" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L95">src/operations/stats.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Collection size in bytes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="storageSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">storage<wbr/>Size<a href="#storageSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">storage<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L99">src/operations/stats.ts:99</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>(Pre)allocated space for the collection in bytes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="totalIndexSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">total<wbr/>Index<wbr/>Size<a href="#totalIndexSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">total<wbr/>Index<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L111">src/operations/stats.ts:111</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Total index size in bytes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="totalSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link">total<wbr/>Size<a href="#totalSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">total<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L134">src/operations/stats.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The sum of the storageSize and totalIndexSize. The scale argument affects this value</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="userFlags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr/>Flags<a href="#userFlags" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">user<wbr/>Flags<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L109">src/operations/stats.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A number that indicates the user-set flags on the collection. userFlags only appears when using the mmapv1 storage engine</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="wiredTiger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> wired<wbr/>Tiger<a href="#wiredTiger" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">wired<wbr/>Tiger<span class="tsd-signature-symbol">?:</span> <a href="WiredTigerData.html" class="tsd-signature-type" data-tsd-kind="Interface">WiredTigerData</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/operations/stats.ts#L124">src/operations/stats.ts:124</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>This document contains data reported directly by the WiredTiger engine and other data for internal diagnostic use</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="label tsd-is-external"><span>Internals</span></li><li class="label tsd-is-external"><span>Externals</span></li><li class=" tsd-kind-namespace tsd-is-external"><a href="../modules/BSON.html">BSON</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CollStats.html" class="tsd-kind-icon">Coll<wbr/>Stats</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#avgObjSize" class="tsd-kind-icon">avg<wbr/>Obj<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#capped" class="tsd-kind-icon">capped</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#count" class="tsd-kind-icon">count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#freeStorageSize" class="tsd-kind-icon">free<wbr/>Storage<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#indexBuilds" class="tsd-kind-icon">index<wbr/>Builds</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#indexDetails" class="tsd-kind-icon">index<wbr/>Details</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#indexSizes" class="tsd-kind-icon">index<wbr/>Sizes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#lastExtentSize" class="tsd-kind-icon">last<wbr/>Extent<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#max" class="tsd-kind-icon">max</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#maxSize" class="tsd-kind-icon">max<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#nindexes" class="tsd-kind-icon">nindexes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#ns" class="tsd-kind-icon">ns</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#numExtents" class="tsd-kind-icon">num<wbr/>Extents</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#ok" class="tsd-kind-icon">ok</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#paddingFactor" class="tsd-kind-icon">padding<wbr/>Factor</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#scaleFactor" class="tsd-kind-icon">scale<wbr/>Factor</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#size" class="tsd-kind-icon">size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#storageSize" class="tsd-kind-icon">storage<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#totalIndexSize" class="tsd-kind-icon">total<wbr/>Index<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#totalSize" class="tsd-kind-icon">total<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#userFlags" class="tsd-kind-icon">user<wbr/>Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CollStats.html#wiredTiger" class="tsd-kind-icon">wired<wbr/>Tiger</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>