-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathCollection.html
294 lines (294 loc) · 178 KB
/
Collection.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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Collection | 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="Collection.html">Collection</a></li></ul><h1>Class Collection<TSchema></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"><div class="lead">
<p>The <strong>Collection</strong> class is an internal class that embodies a MongoDB collection
allowing for insert/find/update/delete and other command operation on that MongoDB collection.</p>
</div><div><p><strong>COLLECTION Cannot directly be instantiated</strong></p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-7">import</span><span class="hl-0"> { </span><span class="hl-6">MongoClient</span><span class="hl-0"> } </span><span class="hl-7">from</span><span class="hl-0"> </span><span class="hl-5">'mongodb'</span><span class="hl-0">;</span><br/><br/><span class="hl-3">interface</span><span class="hl-0"> </span><span class="hl-9">Pet</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-6">name</span><span class="hl-0">: </span><span class="hl-9">string</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-6">kind</span><span class="hl-0">: </span><span class="hl-5">'dog'</span><span class="hl-0"> | </span><span class="hl-5">'cat'</span><span class="hl-0"> | </span><span class="hl-5">'fish'</span><span class="hl-0">;</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">client</span><span class="hl-0"> = </span><span class="hl-3">new</span><span class="hl-0"> </span><span class="hl-2">MongoClient</span><span class="hl-0">(</span><span class="hl-5">'mongodb://localhost:27017'</span><span class="hl-0">);</span><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">pets</span><span class="hl-0"> = </span><span class="hl-6">client</span><span class="hl-0">.</span><span class="hl-2">db</span><span class="hl-0">().</span><span class="hl-2">collection</span><span class="hl-0"><</span><span class="hl-9">Pet</span><span class="hl-0">>(</span><span class="hl-5">'pets'</span><span class="hl-0">);</span><br/><br/><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">petCursor</span><span class="hl-0"> = </span><span class="hl-6">pets</span><span class="hl-0">.</span><span class="hl-2">find</span><span class="hl-0">();</span><br/><br/><span class="hl-7">for</span><span class="hl-0"> </span><span class="hl-7">await</span><span class="hl-0"> (</span><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">pet</span><span class="hl-0"> </span><span class="hl-3">of</span><span class="hl-0"> </span><span class="hl-6">petCursor</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-6">console</span><span class="hl-0">.</span><span class="hl-2">log</span><span class="hl-0">(</span><span class="hl-5">`</span><span class="hl-3">${</span><span class="hl-6">pet</span><span class="hl-11">.</span><span class="hl-6">name</span><span class="hl-3">}</span><span class="hl-5"> is a </span><span class="hl-3">${</span><span class="hl-6">pet</span><span class="hl-11">.</span><span class="hl-6">kind</span><span class="hl-3">}</span><span class="hl-5">!`</span><span class="hl-0">);</span><br/><span class="hl-0">}</span>
</code></pre>
</dd></dl></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>TSchema<span class="tsd-signature-symbol">: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a> = <a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Collection</span></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>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#bsonOptions" class="tsd-kind-icon">bson<wbr/>Options</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#collectionName" class="tsd-kind-icon">collection<wbr/>Name</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#dbName" class="tsd-kind-icon">db<wbr/>Name</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Collection.html#hint" class="tsd-kind-icon">hint</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#namespace" class="tsd-kind-icon">namespace</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#readConcern" class="tsd-kind-icon">read<wbr/>Concern</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#readPreference" class="tsd-kind-icon">read<wbr/>Preference</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#writeConcern" class="tsd-kind-icon">write<wbr/>Concern</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#aggregate" class="tsd-kind-icon">aggregate</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#bulkWrite" class="tsd-kind-icon">bulk<wbr/>Write</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#count" class="tsd-kind-icon">count</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#countDocuments" class="tsd-kind-icon">count<wbr/>Documents</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#createIndex" class="tsd-kind-icon">create<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#createIndexes" class="tsd-kind-icon">create<wbr/>Indexes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#deleteMany" class="tsd-kind-icon">delete<wbr/>Many</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#deleteOne" class="tsd-kind-icon">delete<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#distinct" class="tsd-kind-icon">distinct</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#drop" class="tsd-kind-icon">drop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#dropIndex" class="tsd-kind-icon">drop<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#dropIndexes" class="tsd-kind-icon">drop<wbr/>Indexes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#estimatedDocumentCount" class="tsd-kind-icon">estimated<wbr/>Document<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#find" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#findOne" class="tsd-kind-icon">find<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#findOneAndDelete" class="tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Delete</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#findOneAndReplace" class="tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Replace</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#findOneAndUpdate" class="tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Update</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#indexExists" class="tsd-kind-icon">index<wbr/>Exists</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#indexInformation" class="tsd-kind-icon">index<wbr/>Information</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#indexes" class="tsd-kind-icon">indexes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#initializeOrderedBulkOp" class="tsd-kind-icon">initialize<wbr/>Ordered<wbr/>Bulk<wbr/>Op</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#initializeUnorderedBulkOp" class="tsd-kind-icon">initialize<wbr/>Unordered<wbr/>Bulk<wbr/>Op</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#insertMany" class="tsd-kind-icon">insert<wbr/>Many</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#insertOne" class="tsd-kind-icon">insert<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#isCapped" class="tsd-kind-icon">is<wbr/>Capped</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#listIndexes" class="tsd-kind-icon">list<wbr/>Indexes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#rename" class="tsd-kind-icon">rename</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#replaceOne" class="tsd-kind-icon">replace<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#stats" class="tsd-kind-icon">stats</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#updateMany" class="tsd-kind-icon">update<wbr/>Many</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#updateOne" class="tsd-kind-icon">update<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#watch" class="tsd-kind-icon">watch</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="bsonOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">bson<wbr/>Options<a href="#bsonOptions" 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><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> bsonOptions<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/BSONSerializeOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BSONSerializeOptions</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L221">src/collection.ts:221</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/BSONSerializeOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BSONSerializeOptions</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="collectionName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">collection<wbr/>Name<a href="#collectionName" 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><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> collectionName<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L186">src/collection.ts:186</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of this collection</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="dbName" class="tsd-anchor"></a><h3 class="tsd-anchor-link">db<wbr/>Name<a href="#dbName" 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><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> dbName<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L179">src/collection.ts:179</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the database this collection belongs to</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="hint" class="tsd-anchor"></a><h3 class="tsd-anchor-link">hint<a href="#hint" 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><ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hint<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Hint" class="tsd-signature-type" data-tsd-kind="Type alias">Hint</a></li><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> hint<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Hint" class="tsd-signature-type" data-tsd-kind="Type alias">Hint</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L237">src/collection.ts:237</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The current index hint for the collection</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Hint" class="tsd-signature-type" data-tsd-kind="Type alias">Hint</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L241">src/collection.ts:241</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The current index hint for the collection</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>v: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#Hint" class="tsd-signature-type" data-tsd-kind="Type alias">Hint</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="namespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link">namespace<a href="#namespace" 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><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> namespace<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L194">src/collection.ts:194</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The namespace of this collection, in the format <code>${this.dbName}.${this.collectionName}</code></p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="readConcern" class="tsd-anchor"></a><h3 class="tsd-anchor-link">read<wbr/>Concern<a href="#readConcern" 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><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> readConcern<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ReadConcern.html" class="tsd-signature-type" data-tsd-kind="Class">ReadConcern</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L202">src/collection.ts:202</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The current readConcern of the collection. If not explicitly defined for
this collection, will be inherited from the parent DB</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ReadConcern.html" class="tsd-signature-type" data-tsd-kind="Class">ReadConcern</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="readPreference" class="tsd-anchor"></a><h3 class="tsd-anchor-link">read<wbr/>Preference<a href="#readPreference" 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><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> readPreference<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ReadPreference.html" class="tsd-signature-type" data-tsd-kind="Class">ReadPreference</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L213">src/collection.ts:213</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The current readPreference of the collection. If not explicitly defined for
this collection, will be inherited from the parent DB</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ReadPreference.html" class="tsd-signature-type" data-tsd-kind="Class">ReadPreference</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="writeConcern" class="tsd-anchor"></a><h3 class="tsd-anchor-link">write<wbr/>Concern<a href="#writeConcern" 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><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> writeConcern<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L229">src/collection.ts:229</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The current writeConcern of the collection. If not explicitly defined for
this collection, will be inherited from the parent DB</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="aggregate" class="tsd-anchor"></a><h3 class="tsd-anchor-link">aggregate<a href="#aggregate" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">aggregate<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>pipeline<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AggregationCursor.html" class="tsd-signature-type" data-tsd-kind="Class">AggregationCursor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L871">src/collection.ts:871</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Execute an aggregation framework pipeline against the collection, needs MongoDB >= 2.2</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a> = <a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>pipeline: <a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>An array of aggregation pipelines to execute</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="AggregationCursor.html" class="tsd-signature-type" data-tsd-kind="Class">AggregationCursor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="bulkWrite" class="tsd-anchor"></a><h3 class="tsd-anchor-link">bulk<wbr/>Write<a href="#bulkWrite" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">bulk<wbr/>Write<span class="tsd-signature-symbol">(</span>operations<span class="tsd-signature-symbol">: </span><a href="../modules.html#AnyBulkWriteOperation" class="tsd-signature-type" data-tsd-kind="Type alias">AnyBulkWriteOperation</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BulkWriteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BulkWriteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="BulkWriteResult.html" class="tsd-signature-type" data-tsd-kind="Class">BulkWriteResult</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L308">src/collection.ts:308</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Perform a bulkWrite operation without a fluent API</p>
</div><div><p>Legal operation types are</p>
<ul>
<li><code>insertOne</code></li>
<li><code>replaceOne</code></li>
<li><code>updateOne</code></li>
<li><code>updateMany</code></li>
<li><code>deleteOne</code></li>
<li><code>deleteMany</code></li>
</ul>
<p>If documents passed in do not contain the <strong>_id</strong> field,
one will be added to each of the documents missing it by the driver, mutating the document. This behavior
can be overridden by setting the <strong>forceServerObjectId</strong> flag.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>MongoDriverError if operations is not an array</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>operations: <a href="../modules.html#AnyBulkWriteOperation" class="tsd-signature-type" data-tsd-kind="Type alias">AnyBulkWriteOperation</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Bulk operations to perform</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/BulkWriteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BulkWriteOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="BulkWriteResult.html" class="tsd-signature-type" data-tsd-kind="Class">BulkWriteResult</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">count<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">?: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CountOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CountOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L976">src/collection.ts:976</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>An estimated count of matching documents in the db to a filter.</p>
</div><div><p><strong>NOTE:</strong> This method has been deprecated, since it does not provide an accurate count of the documents
in a collection. To obtain an accurate count of documents in the collection, use {@link Collection#countDocuments| countDocuments}.
To obtain an estimated count of all documents in the collection, use {@link Collection#estimatedDocumentCount| estimatedDocumentCount}.</p>
</div><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>use {@link Collection#countDocuments| countDocuments} or {@link Collection#estimatedDocumentCount| estimatedDocumentCount} instead</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter for the count.</p>
</div></div></li><li><h5>options: <a href="../interfaces/CountOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CountOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="countDocuments" class="tsd-anchor"></a><h3 class="tsd-anchor-link">count<wbr/>Documents<a href="#countDocuments" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">count<wbr/>Documents<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CountDocumentsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CountDocumentsOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L721">src/collection.ts:721</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets the number of documents matching the filter.
For a fast count of the total documents in a collection see {@link Collection#estimatedDocumentCount| estimatedDocumentCount}.
<strong>Note</strong>: When migrating from {@link Collection#count| count} to {@link Collection#countDocuments| countDocuments}
the following query operators must be replaced:</p>
</div><div><table>
<thead>
<tr>
<th>Operator</th>
<th>Replacement</th>
</tr>
</thead>
<tbody><tr>
<td><code>$where</code></td>
<td><a href="https://www.mongodb.com/docs/manual/reference/operator/query/expr/"><code>$expr</code></a></td>
</tr>
<tr>
<td><code>$near</code></td>
<td><a href="https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/"><code>$geoWithin</code></a> with <a href="https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center"><code>$center</code></a></td>
</tr>
<tr>
<td><code>$nearSphere</code></td>
<td><a href="https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/"><code>$geoWithin</code></a> with <a href="https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere"><code>$centerSphere</code></a></td>
</tr>
</tbody></table>
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://www.mongodb.com/docs/manual/reference/operator/query/expr/">https://www.mongodb.com/docs/manual/reference/operator/query/expr/</a></p>
</dd><dt>see</dt><dd><p><a href="https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/">https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/</a></p>
</dd><dt>see</dt><dd><p><a href="https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center">https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center</a></p>
</dd><dt>see</dt><dd><p><a href="https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere">https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere</a></p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter for the count</p>
</div></div></li><li><h5>options: <a href="../interfaces/CountDocumentsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CountDocumentsOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Index<a href="#createIndex" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Index<span class="tsd-signature-symbol">(</span>indexSpec<span class="tsd-signature-symbol">: </span><a href="../modules.html#IndexSpecification" class="tsd-signature-type" data-tsd-kind="Type alias">IndexSpecification</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CreateIndexesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateIndexesOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L550">src/collection.ts:550</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates an index on the db and collection collection.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">collection</span><span class="hl-0"> = </span><span class="hl-6">client</span><span class="hl-0">.</span><span class="hl-2">db</span><span class="hl-0">(</span><span class="hl-5">'foo'</span><span class="hl-0">).</span><span class="hl-2">collection</span><span class="hl-0">(</span><span class="hl-5">'bar'</span><span class="hl-0">);</span><br/><br/><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">createIndex</span><span class="hl-0">({ </span><span class="hl-6">a:</span><span class="hl-0"> </span><span class="hl-8">1</span><span class="hl-0">, </span><span class="hl-6">b:</span><span class="hl-0"> -</span><span class="hl-8">1</span><span class="hl-0"> });</span><br/><br/><span class="hl-1">// Alternate syntax for { c: 1, d: -1 } that ensures order of indexes</span><br/><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">createIndex</span><span class="hl-0">([ [</span><span class="hl-6">c</span><span class="hl-0">, </span><span class="hl-8">1</span><span class="hl-0">], [</span><span class="hl-6">d</span><span class="hl-0">, -</span><span class="hl-8">1</span><span class="hl-0">] ]);</span><br/><br/><span class="hl-1">// Equivalent to { e: 1 }</span><br/><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">createIndex</span><span class="hl-0">(</span><span class="hl-5">'e'</span><span class="hl-0">);</span><br/><br/><span class="hl-1">// Equivalent to { f: 1, g: 1 }</span><br/><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">createIndex</span><span class="hl-0">([</span><span class="hl-5">'f'</span><span class="hl-0">, </span><span class="hl-5">'g'</span><span class="hl-0">])</span><br/><br/><span class="hl-1">// Equivalent to { h: 1, i: -1 }</span><br/><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">createIndex</span><span class="hl-0">([ { </span><span class="hl-6">h:</span><span class="hl-0"> </span><span class="hl-8">1</span><span class="hl-0"> }, { </span><span class="hl-6">i:</span><span class="hl-0"> -</span><span class="hl-8">1</span><span class="hl-0"> } ]);</span><br/><br/><span class="hl-1">// Equivalent to { j: 1, k: -1, l: 2d }</span><br/><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">createIndex</span><span class="hl-0">([</span><span class="hl-5">'j'</span><span class="hl-0">, [</span><span class="hl-5">'k'</span><span class="hl-0">, -</span><span class="hl-8">1</span><span class="hl-0">], { </span><span class="hl-6">l:</span><span class="hl-0"> </span><span class="hl-5">'2d'</span><span class="hl-0"> }])</span>
</code></pre>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>indexSpec: <a href="../modules.html#IndexSpecification" class="tsd-signature-type" data-tsd-kind="Type alias">IndexSpecification</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The field name or index specification to create an index for</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/CreateIndexesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateIndexesOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createIndexes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Indexes<a href="#createIndexes" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Indexes<span class="tsd-signature-symbol">(</span>indexSpecs<span class="tsd-signature-symbol">: </span><a href="../interfaces/IndexDescription.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexDescription</a><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CreateIndexesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateIndexesOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L596">src/collection.ts:596</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates multiple indexes in the collection, this method is only supported for
MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
error.</p>
</div><div><p><strong>Note</strong>: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications.
Index specifications are defined <a href="https://www.mongodb.com/docs/manual/reference/command/createIndexes/" class="external">here</a>.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code class="language-ts"><span class="hl-3">const</span><span class="hl-0"> </span><span class="hl-4">collection</span><span class="hl-0"> = </span><span class="hl-6">client</span><span class="hl-0">.</span><span class="hl-2">db</span><span class="hl-0">(</span><span class="hl-5">'foo'</span><span class="hl-0">).</span><span class="hl-2">collection</span><span class="hl-0">(</span><span class="hl-5">'bar'</span><span class="hl-0">);</span><br/><span class="hl-7">await</span><span class="hl-0"> </span><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">createIndexes</span><span class="hl-0">([</span><br/><span class="hl-0"> </span><span class="hl-1">// Simple index on field fizz</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-6">key:</span><span class="hl-0"> { </span><span class="hl-6">fizz:</span><span class="hl-0"> </span><span class="hl-8">1</span><span class="hl-0"> },</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-1">// wildcard index</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-6">key:</span><span class="hl-0"> { </span><span class="hl-5">'$**'</span><span class="hl-6">:</span><span class="hl-0"> </span><span class="hl-8">1</span><span class="hl-0"> }</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> </span><span class="hl-1">// named index on darmok and jalad</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-6">key:</span><span class="hl-0"> { </span><span class="hl-6">darmok:</span><span class="hl-0"> </span><span class="hl-8">1</span><span class="hl-0">, </span><span class="hl-6">jalad:</span><span class="hl-0"> -</span><span class="hl-8">1</span><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-6">name</span><span class="hl-0">: </span><span class="hl-5">'tanagra'</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">]);</span>
</code></pre>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>indexSpecs: <a href="../interfaces/IndexDescription.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexDescription</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>An array of index specifications to be created</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/CreateIndexesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateIndexesOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delete<wbr/>Many<a href="#deleteMany" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Many<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">?: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/DeleteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeleteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DeleteResult.html" class="tsd-signature-type" data-tsd-kind="Interface">DeleteResult</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L417">src/collection.ts:417</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Delete multiple documents from a collection</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter used to select the documents to remove</p>
</div></div></li><li><h5>options: <a href="../interfaces/DeleteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeleteOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DeleteResult.html" class="tsd-signature-type" data-tsd-kind="Interface">DeleteResult</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delete<wbr/>One<a href="#deleteOne" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>One<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">?: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/DeleteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeleteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DeleteResult.html" class="tsd-signature-type" data-tsd-kind="Interface">DeleteResult</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L401">src/collection.ts:401</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Delete a document from a collection</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter used to select the document to remove</p>
</div></div></li><li><h5>options: <a href="../interfaces/DeleteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DeleteOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/DeleteResult.html" class="tsd-signature-type" data-tsd-kind="Interface">DeleteResult</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="distinct" class="tsd-anchor"></a><h3 class="tsd-anchor-link">distinct<a href="#distinct" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">distinct<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Flatten" class="tsd-signature-type" data-tsd-kind="Type alias">Flatten</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">distinct<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span>, filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Flatten" class="tsd-signature-type" data-tsd-kind="Type alias">Flatten</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">distinct<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span>, filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Flatten" class="tsd-signature-type" data-tsd-kind="Type alias">Flatten</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">distinct<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">distinct<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">distinct<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L738">src/collection.ts:738</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The distinct command returns a list of distinct values for the given key across a collection.</p>
</div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Field of the document to find distinct values for</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Flatten" class="tsd-signature-type" data-tsd-kind="Type alias">Flatten</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L741">src/collection.ts:741</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span></h5></li><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Flatten" class="tsd-signature-type" data-tsd-kind="Type alias">Flatten</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L745">src/collection.ts:745</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span></h5></li><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>options: <a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules.html#Flatten" class="tsd-signature-type" data-tsd-kind="Type alias">Flatten</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Key</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L752">src/collection.ts:752</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L753">src/collection.ts:753</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L754">src/collection.ts:754</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>options: <a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="drop" class="tsd-anchor"></a><h3 class="tsd-anchor-link">drop<a href="#drop" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">drop<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/DropCollectionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DropCollectionOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L452">src/collection.ts:452</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Drop the collection from the database, removing it permanently. New accesses will create a new collection.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/DropCollectionOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DropCollectionOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="dropIndex" class="tsd-anchor"></a><h3 class="tsd-anchor-link">drop<wbr/>Index<a href="#dropIndex" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">drop<wbr/>Index<span class="tsd-signature-symbol">(</span>indexName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L617">src/collection.ts:617</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Drops an index from this collection.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>indexName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Name of the index to drop.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="dropIndexes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">drop<wbr/>Indexes<a href="#dropIndexes" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">drop<wbr/>Indexes<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L632">src/collection.ts:632</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Drops all indexes from this collection.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="estimatedDocumentCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link">estimated<wbr/>Document<wbr/>Count<a href="#estimatedDocumentCount" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">estimated<wbr/>Document<wbr/>Count<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/EstimatedDocumentCountOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EstimatedDocumentCountOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L689">src/collection.ts:689</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Gets an estimate of the count of documents in a collection using collection metadata.
This will always run a count command on all server versions.</p>
</div><div><p>due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the count command,
which estimatedDocumentCount uses in its implementation, was not included in v1 of
the Stable API, and so users of the Stable API with estimatedDocumentCount are
recommended to upgrade their server version to 5.0.9+ or set apiStrict: false to avoid
encountering errors.</p>
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://www.mongodb.com/docs/manual/reference/command/count/#behavior" class="external">Count: Behavior</a></p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/EstimatedDocumentCountOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EstimatedDocumentCountOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="find" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<a href="#find" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FindCursor.html" class="tsd-signature-type" data-tsd-kind="Class">FindCursor</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/FindOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOptions</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FindCursor.html" class="tsd-signature-type" data-tsd-kind="Class">FindCursor</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/FindOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOptions</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FindCursor.html" class="tsd-signature-type" data-tsd-kind="Class">FindCursor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L486">src/collection.ts:486</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a cursor for a filter that can be used to iterate over results from MongoDB</p>
</div></div><h4 class="tsd-returns-title">Returns <a href="FindCursor.html" class="tsd-signature-type" data-tsd-kind="Class">FindCursor</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L487">src/collection.ts:487</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/FindOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOptions</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="FindCursor.html" class="tsd-signature-type" data-tsd-kind="Class">FindCursor</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L488">src/collection.ts:488</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/FindOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOptions</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="FindCursor.html" class="tsd-signature-type" data-tsd-kind="Class">FindCursor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="findOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<wbr/>One<a href="#findOne" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">find<wbr/>One<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">find<wbr/>One<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">find<wbr/>One<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/FindOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOptions</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">find<wbr/>One<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">find<wbr/>One<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">find<wbr/>One<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/FindOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOptions</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L465">src/collection.ts:465</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Fetches the first document that matches the filter</p>
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L466">src/collection.ts:466</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L467">src/collection.ts:467</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li><li><h5>options: <a href="../interfaces/FindOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOptions</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules.html#WithId" class="tsd-signature-type" data-tsd-kind="Type alias">WithId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L470">src/collection.ts:470</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">TSchema</span></h4></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L471">src/collection.ts:471</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">TSchema</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L472">src/collection.ts:472</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <span class="tsd-signature-type">TSchema</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/FindOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOptions</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="findOneAndDelete" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<wbr/>One<wbr/>And<wbr/>Delete<a href="#findOneAndDelete" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Delete<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/FindOneAndDeleteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOneAndDeleteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ModifyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ModifyResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L805">src/collection.ts:805</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Find a document and delete it in one atomic operation. Requires a write lock for the duration of the operation.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter used to select the document to remove</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/FindOneAndDeleteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOneAndDeleteOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ModifyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ModifyResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="findOneAndReplace" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<wbr/>One<wbr/>And<wbr/>Replace<a href="#findOneAndReplace" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Replace<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, replacement<span class="tsd-signature-symbol">: </span><a href="../modules.html#WithoutId" class="tsd-signature-type" data-tsd-kind="Type alias">WithoutId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/FindOneAndReplaceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOneAndReplaceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ModifyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ModifyResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L826">src/collection.ts:826</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Find a document and replace it in one atomic operation. Requires a write lock for the duration of the operation.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter used to select the document to replace</p>
</div></div></li><li><h5>replacement: <a href="../modules.html#WithoutId" class="tsd-signature-type" data-tsd-kind="Type alias">WithoutId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The Document that replaces the matching document</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/FindOneAndReplaceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOneAndReplaceOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ModifyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ModifyResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="findOneAndUpdate" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<wbr/>One<wbr/>And<wbr/>Update<a href="#findOneAndUpdate" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Update<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="../modules.html#UpdateFilter" class="tsd-signature-type" data-tsd-kind="Type alias">UpdateFilter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/FindOneAndUpdateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOneAndUpdateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ModifyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ModifyResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L849">src/collection.ts:849</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter used to select the document to update</p>
</div></div></li><li><h5>update: <a href="../modules.html#UpdateFilter" class="tsd-signature-type" data-tsd-kind="Type alias">UpdateFilter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Update operations to be performed on the document</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/FindOneAndUpdateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">FindOneAndUpdateOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ModifyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">ModifyResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="indexExists" class="tsd-anchor"></a><h3 class="tsd-anchor-link">index<wbr/>Exists<a href="#indexExists" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">index<wbr/>Exists<span class="tsd-signature-symbol">(</span>indexes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/IndexInformationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexInformationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L654">src/collection.ts:654</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Checks if one or more indexes exist on the collection, fails on first non-existing index</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>indexes: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>One or more index names to check.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/IndexInformationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexInformationOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="indexInformation" class="tsd-anchor"></a><h3 class="tsd-anchor-link">index<wbr/>Information<a href="#indexInformation" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">index<wbr/>Information<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/IndexInformationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexInformationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L669">src/collection.ts:669</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Retrieves this collections index info.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/IndexInformationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexInformationOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="indexes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">indexes<a href="#indexes" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">indexes<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/IndexInformationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexInformationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L777">src/collection.ts:777</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Retrieve all the indexes on the collection.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/IndexInformationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IndexInformationOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="initializeOrderedBulkOp" class="tsd-anchor"></a><h3 class="tsd-anchor-link">initialize<wbr/>Ordered<wbr/>Bulk<wbr/>Op<a href="#initializeOrderedBulkOp" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">initialize<wbr/>Ordered<wbr/>Bulk<wbr/>Op<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BulkWriteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BulkWriteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="OrderedBulkOperation.html" class="tsd-signature-type" data-tsd-kind="Class">OrderedBulkOperation</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L960">src/collection.ts:960</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>MongoNotConnectedError</p>
</dd><dt>remarks</dt><dd><p><strong>NOTE:</strong> MongoClient must be connected prior to calling this method due to a known limitation in this legacy implementation.
However, <code>collection.bulkWrite()</code> provides an equivalent API that does not require prior connecting.</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/BulkWriteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BulkWriteOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="OrderedBulkOperation.html" class="tsd-signature-type" data-tsd-kind="Class">OrderedBulkOperation</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="initializeUnorderedBulkOp" class="tsd-anchor"></a><h3 class="tsd-anchor-link">initialize<wbr/>Unordered<wbr/>Bulk<wbr/>Op<a href="#initializeUnorderedBulkOp" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">initialize<wbr/>Unordered<wbr/>Bulk<wbr/>Op<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BulkWriteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BulkWriteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="UnorderedBulkOperation.html" class="tsd-signature-type" data-tsd-kind="Class">UnorderedBulkOperation</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L948">src/collection.ts:948</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.</p>
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>MongoNotConnectedError</p>
</dd><dt>remarks</dt><dd><p><strong>NOTE:</strong> MongoClient must be connected prior to calling this method due to a known limitation in this legacy implementation.
However, <code>collection.bulkWrite()</code> provides an equivalent API that does not require prior connecting.</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/BulkWriteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BulkWriteOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="UnorderedBulkOperation.html" class="tsd-signature-type" data-tsd-kind="Class">UnorderedBulkOperation</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="insertMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link">insert<wbr/>Many<a href="#insertMany" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">insert<wbr/>Many<span class="tsd-signature-symbol">(</span>docs<span class="tsd-signature-symbol">: </span><a href="../modules.html#OptionalUnlessRequiredId" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalUnlessRequiredId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BulkWriteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BulkWriteOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/InsertManyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">InsertManyResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L275">src/collection.ts:275</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Inserts an array of documents into MongoDB. If documents passed in do not contain the <strong>_id</strong> field,
one will be added to each of the documents missing it by the driver, mutating the document. This behavior
can be overridden by setting the <strong>forceServerObjectId</strong> flag.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>docs: <a href="../modules.html#OptionalUnlessRequiredId" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalUnlessRequiredId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The documents to insert</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/BulkWriteOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BulkWriteOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/InsertManyResult.html" class="tsd-signature-type" data-tsd-kind="Interface">InsertManyResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="insertOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link">insert<wbr/>One<a href="#insertOne" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">insert<wbr/>One<span class="tsd-signature-symbol">(</span>doc<span class="tsd-signature-symbol">: </span><a href="../modules.html#OptionalUnlessRequiredId" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalUnlessRequiredId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/InsertOneOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">InsertOneOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/InsertOneResult.html" class="tsd-signature-type" data-tsd-kind="Interface">InsertOneResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L253">src/collection.ts:253</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Inserts a single document into MongoDB. If documents passed in do not contain the <strong>_id</strong> field,
one will be added to each of the documents missing it by the driver, mutating the document. This behavior
can be overridden by setting the <strong>forceServerObjectId</strong> flag.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>doc: <a href="../modules.html#OptionalUnlessRequiredId" class="tsd-signature-type" data-tsd-kind="Type alias">OptionalUnlessRequiredId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The document to insert</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/InsertOneOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">InsertOneOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/InsertOneResult.html" class="tsd-signature-type" data-tsd-kind="Interface">InsertOneResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isCapped" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Capped<a href="#isCapped" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Capped<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/OperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L515">src/collection.ts:515</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns if the collection is a capped collection</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/OperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="listIndexes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">list<wbr/>Indexes<a href="#listIndexes" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">list<wbr/>Indexes<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ListIndexesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ListIndexesOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListIndexesCursor.html" class="tsd-signature-type" data-tsd-kind="Class">ListIndexesCursor</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L644">src/collection.ts:644</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get the list of all indexes information for the collection.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/ListIndexesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ListIndexesOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ListIndexesCursor.html" class="tsd-signature-type" data-tsd-kind="Class">ListIndexesCursor</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link">options<a href="#options" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/OperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L503">src/collection.ts:503</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the options of the collection.</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/OperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="rename" class="tsd-anchor"></a><h3 class="tsd-anchor-link">rename<a href="#rename" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">rename<span class="tsd-signature-symbol">(</span>newName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RenameOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RenameOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Collection.html" class="tsd-signature-type" data-tsd-kind="Class">Collection</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L436">src/collection.ts:436</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Rename the collection.</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>This operation does not inherit options from the Db or MongoClient.</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>newName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>New name of of the collection.</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/RenameOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RenameOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Collection.html" class="tsd-signature-type" data-tsd-kind="Class">Collection</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="replaceOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link">replace<wbr/>One<a href="#replaceOne" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">replace<wbr/>One<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, replacement<span class="tsd-signature-symbol">: </span><a href="../modules.html#WithoutId" class="tsd-signature-type" data-tsd-kind="Type alias">WithoutId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ReplaceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ReplaceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/UpdateResult.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L356">src/collection.ts:356</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Replace a document in a collection with another document</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter used to select the document to replace</p>
</div></div></li><li><h5>replacement: <a href="../modules.html#WithoutId" class="tsd-signature-type" data-tsd-kind="Type alias">WithoutId</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The Document that replaces the matching document</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/ReplaceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ReplaceOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/UpdateResult.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stats" class="tsd-anchor"></a><h3 class="tsd-anchor-link">stats<a href="#stats" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">stats<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CollStatsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CollStatsOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CollStats.html" class="tsd-signature-type" data-tsd-kind="Interface">CollStats</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L792">src/collection.ts:792</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Get all the collection statistics.</p>
</div><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></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/CollStatsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CollStatsOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CollStats.html" class="tsd-signature-type" data-tsd-kind="Interface">CollStats</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updateMany" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<wbr/>Many<a href="#updateMany" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<wbr/>Many<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="../modules.html#UpdateFilter" class="tsd-signature-type" data-tsd-kind="Type alias">UpdateFilter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/UpdateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UpdateResult.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L379">src/collection.ts:379</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Update multiple documents in a collection</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter used to select the documents to update</p>
</div></div></li><li><h5>update: <a href="../modules.html#UpdateFilter" class="tsd-signature-type" data-tsd-kind="Type alias">UpdateFilter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The update operations to be applied to the documents</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/UpdateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UpdateResult.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updateOne" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<wbr/>One<a href="#updateOne" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<wbr/>One<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, update<span class="tsd-signature-symbol">: </span><a href="../modules.html#UpdateFilter" class="tsd-signature-type" data-tsd-kind="Type alias">UpdateFilter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/UpdateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UpdateResult.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L333">src/collection.ts:333</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Update a single document in a collection</p>
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>filter: <a href="../modules.html#Filter" class="tsd-signature-type" data-tsd-kind="Type alias">Filter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The filter used to select the document to update</p>
</div></div></li><li><h5>update: <a href="../modules.html#UpdateFilter" class="tsd-signature-type" data-tsd-kind="Type alias">UpdateFilter</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The update operations to be applied to the document</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/UpdateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/UpdateResult.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateResult</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TSchema</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="watch" class="tsd-anchor"></a><h3 class="tsd-anchor-link">watch<a href="#watch" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">watch<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TLocal</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TChange</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>pipeline<span class="tsd-signature-symbol">?: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ChangeStreamOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ChangeStreamOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ChangeStream.html" class="tsd-signature-type" data-tsd-kind="Class">ChangeStream</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TLocal</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TChange</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/v5.4.0/src/collection.ts#L927">src/collection.ts:927</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.</p>
</div><dl class="tsd-comment-tags"><dt>remarks</dt><dd><p>watch() accepts two generic arguments for distinct use cases:</p>
<ul>
<li>The first is to override the schema that may be defined for this specific collection</li>
<li>The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument</li>
</ul>
</dd><dt>example</dt><dd><p>By just providing the first argument I can type the change to be <code>ChangeStreamDocument<{ _id: number }></code></p>
<pre><code class="language-ts"><span class="hl-6">collection</span><span class="hl-0">.</span><span class="hl-2">watch</span><span class="hl-0"><{ </span><span class="hl-6">_id</span><span class="hl-0">: </span><span class="hl-9">number</span><span class="hl-0"> }>()</span><br/><span class="hl-0"> .</span><span class="hl-2">on</span><span class="hl-0">(</span><span class="hl-5">'change'</span><span class="hl-0">, </span><span class="hl-6">change</span><span class="hl-0"> </span><span class="hl-3">=></span><span class="hl-0"> </span><span class="hl-6">console</span><span class="hl-0">.</span><span class="hl-2">log</span><span class="hl-0">(</span><span class="hl-6">change</span><span class="hl-0">.</span><span class="hl-6">_id</span><span class="hl-0">.</span><span class="hl-2">toFixed</span><span class="hl-0">(</span><span class="hl-8">4</span><span class="hl-0">)));</span>
</code></pre>
</dd><dt>example</dt><dd><p>Passing a second argument provides a way to reflect the type changes caused by an advanced pipeline.
Here, we are using a pipeline to have MongoDB filter for insert changes only and add a comment.
No need start from scratch on the ChangeStreamInsertDocument type!
By using an intersection we can save time and ensure defaults remain the same type!</p>
<pre><code class="language-ts"><span class="hl-6">collection</span><br/><span class="hl-0"> .</span><span class="hl-2">watch</span><span class="hl-0"><</span><span class="hl-9">Schema</span><span class="hl-0">, </span><span class="hl-9">ChangeStreamInsertDocument</span><span class="hl-0"><</span><span class="hl-9">Schema</span><span class="hl-0">> & { </span><span class="hl-6">comment</span><span class="hl-0">: </span><span class="hl-9">string</span><span class="hl-0"> }>([</span><br/><span class="hl-0"> { </span><span class="hl-6">$addFields:</span><span class="hl-0"> { </span><span class="hl-6">comment:</span><span class="hl-0"> </span><span class="hl-5">'big changes'</span><span class="hl-0"> } },</span><br/><span class="hl-0"> { </span><span class="hl-6">$match:</span><span class="hl-0"> { </span><span class="hl-6">operationType:</span><span class="hl-0"> </span><span class="hl-5">'insert'</span><span class="hl-0"> } }</span><br/><span class="hl-0"> ])</span><br/><span class="hl-0"> .</span><span class="hl-2">on</span><span class="hl-0">(</span><span class="hl-5">'change'</span><span class="hl-0">, </span><span class="hl-6">change</span><span class="hl-0"> </span><span class="hl-3">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-6">change</span><span class="hl-0">.</span><span class="hl-6">comment</span><span class="hl-0">.</span><span class="hl-2">startsWith</span><span class="hl-0">(</span><span class="hl-5">'big'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-6">change</span><span class="hl-0">.</span><span class="hl-6">operationType</span><span class="hl-0"> === </span><span class="hl-5">'insert'</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-1">// No need to narrow in code because the generics did that for us!</span><br/><span class="hl-0"> </span><span class="hl-2">expectType</span><span class="hl-0"><</span><span class="hl-9">Schema</span><span class="hl-0">>(</span><span class="hl-6">change</span><span class="hl-0">.</span><span class="hl-6">fullDocument</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span>
</code></pre>
</dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>TLocal<span class="tsd-signature-symbol">: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a> = <span class="tsd-signature-type">TSchema</span></h4><div class="tsd-comment tsd-typography"><div class="lead">
<p>Type of the data being detected by the change stream</p>
</div></div></li><li><h4>TChange<span class="tsd-signature-symbol">: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a> = <a href="../modules.html#ChangeStreamDocument" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeStreamDocument</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TLocal</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="lead">
<p>Type of the whole change stream document emitted</p>
</div></div></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>pipeline: <a href="../interfaces/BSON.Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>An array of <a href="https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/" class="external">aggregation pipeline stages</a> through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.</p>
</div></div></li><li><h5>options: <a href="../interfaces/ChangeStreamOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ChangeStreamOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Optional settings for the command</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ChangeStream.html" class="tsd-signature-type" data-tsd-kind="Class">ChangeStream</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TLocal</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">TChange</span><span class="tsd-signature-symbol">></span></h4></li></ul></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-class tsd-has-type-parameter"><a href="Collection.html" class="tsd-kind-icon">Collection</a><ul><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#bsonOptions" class="tsd-kind-icon">bson<wbr/>Options</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#collectionName" class="tsd-kind-icon">collection<wbr/>Name</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#dbName" class="tsd-kind-icon">db<wbr/>Name</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Collection.html#hint" class="tsd-kind-icon">hint</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#namespace" class="tsd-kind-icon">namespace</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#readConcern" class="tsd-kind-icon">read<wbr/>Concern</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#readPreference" class="tsd-kind-icon">read<wbr/>Preference</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Collection.html#writeConcern" class="tsd-kind-icon">write<wbr/>Concern</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#aggregate" class="tsd-kind-icon">aggregate</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#bulkWrite" class="tsd-kind-icon">bulk<wbr/>Write</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#count" class="tsd-kind-icon">count</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#countDocuments" class="tsd-kind-icon">count<wbr/>Documents</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#createIndex" class="tsd-kind-icon">create<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#createIndexes" class="tsd-kind-icon">create<wbr/>Indexes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#deleteMany" class="tsd-kind-icon">delete<wbr/>Many</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#deleteOne" class="tsd-kind-icon">delete<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#distinct" class="tsd-kind-icon">distinct</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#drop" class="tsd-kind-icon">drop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#dropIndex" class="tsd-kind-icon">drop<wbr/>Index</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#dropIndexes" class="tsd-kind-icon">drop<wbr/>Indexes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#estimatedDocumentCount" class="tsd-kind-icon">estimated<wbr/>Document<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#find" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#findOne" class="tsd-kind-icon">find<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#findOneAndDelete" class="tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Delete</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#findOneAndReplace" class="tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Replace</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#findOneAndUpdate" class="tsd-kind-icon">find<wbr/>One<wbr/>And<wbr/>Update</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#indexExists" class="tsd-kind-icon">index<wbr/>Exists</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#indexInformation" class="tsd-kind-icon">index<wbr/>Information</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#indexes" class="tsd-kind-icon">indexes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#initializeOrderedBulkOp" class="tsd-kind-icon">initialize<wbr/>Ordered<wbr/>Bulk<wbr/>Op</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#initializeUnorderedBulkOp" class="tsd-kind-icon">initialize<wbr/>Unordered<wbr/>Bulk<wbr/>Op</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#insertMany" class="tsd-kind-icon">insert<wbr/>Many</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#insertOne" class="tsd-kind-icon">insert<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#isCapped" class="tsd-kind-icon">is<wbr/>Capped</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#listIndexes" class="tsd-kind-icon">list<wbr/>Indexes</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#rename" class="tsd-kind-icon">rename</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#replaceOne" class="tsd-kind-icon">replace<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#stats" class="tsd-kind-icon">stats</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#updateMany" class="tsd-kind-icon">update<wbr/>Many</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="Collection.html#updateOne" class="tsd-kind-icon">update<wbr/>One</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="Collection.html#watch" class="tsd-kind-icon">watch</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>