-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathIndexDescription.html
21 lines (21 loc) · 38.9 KB
/
IndexDescription.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IndexDescription | 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="IndexDescription.html">IndexDescription</a></li></ul><h1>Interface IndexDescription</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a href="CreateIndexesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateIndexesOptions</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"background"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unique"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"partialFilterExpression"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sparse"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hidden"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"expireAfterSeconds"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"storageEngine"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"version"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"weights"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"default_language"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"language_override"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"textIndexVersion"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2dsphereIndexVersion"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bits"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"min"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"max"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bucketSize"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"wildcardProjection"</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IndexDescription</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 tsd-is-inherited"><a href="IndexDescription.html#2dsphereIndexVersion" class="tsd-kind-icon">2dsphere<wbr/>Index<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#background" class="tsd-kind-icon">background</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#bits" class="tsd-kind-icon">bits</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#bucketSize" class="tsd-kind-icon">bucket<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IndexDescription.html#collation" class="tsd-kind-icon">collation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#default_language" class="tsd-kind-icon">default_<wbr/>language</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#expireAfterSeconds" class="tsd-kind-icon">expire<wbr/>After<wbr/>Seconds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#hidden" class="tsd-kind-icon">hidden</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IndexDescription.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#language_override" class="tsd-kind-icon">language_<wbr/>override</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#max" class="tsd-kind-icon">max</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#min" class="tsd-kind-icon">min</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IndexDescription.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#partialFilterExpression" class="tsd-kind-icon">partial<wbr/>Filter<wbr/>Expression</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#sparse" class="tsd-kind-icon">sparse</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#storageEngine" class="tsd-kind-icon">storage<wbr/>Engine</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#textIndexVersion" class="tsd-kind-icon">text<wbr/>Index<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#unique" class="tsd-kind-icon">unique</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#weights" class="tsd-kind-icon">weights</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#wildcardProjection" class="tsd-kind-icon">wildcard<wbr/>Projection</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 tsd-is-inherited"><a id="2dsphereIndexVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> 2dsphere<wbr/>Index<wbr/>Version<a href="#2dsphereIndexVersion" 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">2dsphere<wbr/>Index<wbr/>Version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Pick.2dsphereIndexVersion</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L130">src/operations/indexes.ts:130</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="background" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> background<a href="#background" 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">background<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from Pick.background</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L107">src/operations/indexes.ts:107</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates the index in the background, yielding whenever possible.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="bits" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> bits<a href="#bits" 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">bits<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Pick.bits</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L132">src/operations/indexes.ts:132</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="bucketSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> bucket<wbr/>Size<a href="#bucketSize" 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">bucket<wbr/>Size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Pick.bucketSize</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L138">src/operations/indexes.ts:138</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="collation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> collation<a href="#collation" 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">collation<span class="tsd-signature-symbol">?:</span> <a href="CollationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CollationOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L99">src/operations/indexes.ts:99</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="default_language" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> default_<wbr/>language<a href="#default_language" 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">default_<wbr/>language<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Pick.default_language</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L126">src/operations/indexes.ts:126</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="expireAfterSeconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> expire<wbr/>After<wbr/>Seconds<a href="#expireAfterSeconds" 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">expire<wbr/>After<wbr/>Seconds<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Pick.expireAfterSeconds</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L117">src/operations/indexes.ts:117</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Allows you to expire data on indexes applied to a data (MongoDB 2.2 or higher)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="hidden" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> hidden<a href="#hidden" 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">hidden<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from Pick.hidden</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L142">src/operations/indexes.ts:142</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies that the index should exist on the target collection but should not be used by the query planner when executing operations. (MongoDB 4.4 or higher)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link">key<a href="#key" 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">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../modules.html#IndexDirection" class="tsd-signature-type" data-tsd-kind="Type alias">IndexDirection</a><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.3.0/src/operations/indexes.ts#L101">src/operations/indexes.ts:101</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="language_override" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> language_<wbr/>override<a href="#language_override" 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">language_<wbr/>override<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Pick.language_override</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L127">src/operations/indexes.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="max" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> 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"><p>Inherited from Pick.max</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L136">src/operations/indexes.ts:136</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>For geospatial indexes set the high bound for the co-ordinates.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="min" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> min<a href="#min" 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">min<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Pick.min</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L134">src/operations/indexes.ts:134</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>For geospatial indexes set the lower bound for the co-ordinates.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> name<a href="#name" 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">name<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.3.0/src/operations/indexes.ts#L100">src/operations/indexes.ts:100</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="partialFilterExpression" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> partial<wbr/>Filter<wbr/>Expression<a href="#partialFilterExpression" 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">partial<wbr/>Filter<wbr/>Expression<span class="tsd-signature-symbol">?:</span> <a href="BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from Pick.partialFilterExpression</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L113">src/operations/indexes.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a partial index based on the given filter object (MongoDB 3.2 or higher)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="sparse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sparse<a href="#sparse" 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">sparse<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from Pick.sparse</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L115">src/operations/indexes.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a sparse index.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="storageEngine" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> storage<wbr/>Engine<a href="#storageEngine" 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/>Engine<span class="tsd-signature-symbol">?:</span> <a href="BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from Pick.storageEngine</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L119">src/operations/indexes.ts:119</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Allows users to configure the storage engine on a per-index basis when creating an index. (MongoDB 3.0 or higher)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="textIndexVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> text<wbr/>Index<wbr/>Version<a href="#textIndexVersion" 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">text<wbr/>Index<wbr/>Version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Pick.textIndexVersion</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L128">src/operations/indexes.ts:128</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="unique" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> unique<a href="#unique" 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">unique<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from Pick.unique</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L109">src/operations/indexes.ts:109</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates an unique index.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="version" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> version<a href="#version" 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">version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from Pick.version</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L123">src/operations/indexes.ts:123</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies the index version number, either 0 or 1.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="weights" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> weights<a href="#weights" 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">weights<span class="tsd-signature-symbol">?:</span> <a href="BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from Pick.weights</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L125">src/operations/indexes.ts:125</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="wildcardProjection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> wildcard<wbr/>Projection<a href="#wildcardProjection" 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">wildcard<wbr/>Projection<span class="tsd-signature-symbol">?:</span> <a href="BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from Pick.wildcardProjection</p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.3.0/src/operations/indexes.ts#L140">src/operations/indexes.ts:140</a></li></ul></aside></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="IndexDescription.html" class="tsd-kind-icon">Index<wbr/>Description</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#2dsphereIndexVersion" class="tsd-kind-icon">2dsphere<wbr/>Index<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#background" class="tsd-kind-icon">background</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#bits" class="tsd-kind-icon">bits</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#bucketSize" class="tsd-kind-icon">bucket<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IndexDescription.html#collation" class="tsd-kind-icon">collation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#default_language" class="tsd-kind-icon">default_<wbr/>language</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#expireAfterSeconds" class="tsd-kind-icon">expire<wbr/>After<wbr/>Seconds</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#hidden" class="tsd-kind-icon">hidden</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IndexDescription.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#language_override" class="tsd-kind-icon">language_<wbr/>override</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#max" class="tsd-kind-icon">max</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#min" class="tsd-kind-icon">min</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IndexDescription.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#partialFilterExpression" class="tsd-kind-icon">partial<wbr/>Filter<wbr/>Expression</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#sparse" class="tsd-kind-icon">sparse</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#storageEngine" class="tsd-kind-icon">storage<wbr/>Engine</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#textIndexVersion" class="tsd-kind-icon">text<wbr/>Index<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#unique" class="tsd-kind-icon">unique</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#weights" class="tsd-kind-icon">weights</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="IndexDescription.html#wildcardProjection" class="tsd-kind-icon">wildcard<wbr/>Projection</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>