-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathAggregateOptions.html
52 lines (52 loc) · 42.9 KB
/
AggregateOptions.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
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>AggregateOptions | 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><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="AggregateOptions.html">AggregateOptions</a></li></ul><h1>Interface AggregateOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="CommandOperationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOperationOptions</a><ul class="tsd-hierarchy"><li><span class="target">AggregateOptions</span><ul class="tsd-hierarchy"><li><a href="ChangeStreamOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ChangeStreamOptions</a></li><li><a href="AggregationCursorOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregationCursorOptions</a></li><li><a href="CountDocumentsOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CountDocumentsOptions</a></li></ul></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#allowDiskUse" class="tsd-kind-icon">allow<wbr/>Disk<wbr/>Use</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#authdb" class="tsd-kind-icon">authdb</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#batchSize" class="tsd-kind-icon">batch<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#bsonRegExp" class="tsd-kind-icon">bson<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#bypassDocumentValidation" class="tsd-kind-icon">bypass<wbr/>Document<wbr/>Validation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#bypassPinningCheck" class="tsd-kind-icon">bypass<wbr/>Pinning<wbr/>Check</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#checkKeys" class="tsd-kind-icon">check<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AggregateOptions.html#collation" class="tsd-kind-icon">collation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#comment" class="tsd-kind-icon">comment</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#cursor" class="tsd-kind-icon">cursor</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#dbName" class="tsd-kind-icon">db<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#explain" class="tsd-kind-icon">explain</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#fieldsAsRaw" class="tsd-kind-icon">fields<wbr/>As<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#fullResponse" class="tsd-kind-icon">full<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#hint" class="tsd-kind-icon">hint</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#ignoreUndefined" class="tsd-kind-icon">ignore<wbr/>Undefined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#let" class="tsd-kind-icon">let</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#maxAwaitTimeMS" class="tsd-kind-icon">max<wbr/>Await<wbr/>TimeMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AggregateOptions.html#maxTimeMS" class="tsd-kind-icon">max<wbr/>TimeMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#noResponse" class="tsd-kind-icon">no<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#omitReadPreference" class="tsd-kind-icon">omit<wbr/>Read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#out" class="tsd-kind-icon">out</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#promoteBuffers" class="tsd-kind-icon">promote<wbr/>Buffers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#promoteLongs" class="tsd-kind-icon">promote<wbr/>Longs</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#promoteValues" class="tsd-kind-icon">promote<wbr/>Values</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#raw" class="tsd-kind-icon">raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#readConcern" class="tsd-kind-icon">read<wbr/>Concern</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#readPreference" class="tsd-kind-icon">read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#retryWrites" class="tsd-kind-icon">retry<wbr/>Writes</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#serializeFunctions" class="tsd-kind-icon">serialize<wbr/>Functions</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#session" class="tsd-kind-icon">session</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#willRetryWrites" class="tsd-kind-icon">will<wbr/>Retry<wbr/>Writes</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#writeConcern" class="tsd-kind-icon">write<wbr/>Concern</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="allowDiskUse" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr/>Disk<wbr/>Use</h3><div class="tsd-signature tsd-kind-icon">allow<wbr/>Disk<wbr/>Use<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L17">src/operations/aggregate.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="authdb" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> authdb</h3><div class="tsd-signature tsd-kind-icon">authdb<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#authdb">authdb</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/command.ts#L49">src/operations/command.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="batchSize" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> batch<wbr/>Size</h3><div class="tsd-signature tsd-kind-icon">batch<wbr/>Size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L19">src/operations/aggregate.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The number of documents to return per batch. See <a href="https://www.mongodb.com/docs/manual/reference/command/aggregate">aggregation documentation</a>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="bsonRegExp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> bson<wbr/>Reg<wbr/>Exp</h3><div class="tsd-signature tsd-kind-icon">bson<wbr/>Reg<wbr/>Exp<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#bsonRegExp">bsonRegExp</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:336</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>return BSON regular expressions as BSONRegExp instances.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="bypassDocumentValidation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> bypass<wbr/>Document<wbr/>Validation</h3><div class="tsd-signature tsd-kind-icon">bypass<wbr/>Document<wbr/>Validation<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L21">src/operations/aggregate.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Allow driver to bypass schema validation in MongoDB 3.2 or higher.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="bypassPinningCheck" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> bypass<wbr/>Pinning<wbr/>Check</h3><div class="tsd-signature tsd-kind-icon">bypass<wbr/>Pinning<wbr/>Check<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#bypassPinningCheck">bypassPinningCheck</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/operation.ts#L33">src/operations/operation.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="checkKeys" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr/>Keys</h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Keys<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#checkKeys">checkKeys</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:950</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>the serializer will check if keys are valid.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a name="collation" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> collation</h3><div class="tsd-signature tsd-kind-icon">collation<span class="tsd-signature-symbol">?:</span> <a href="CollationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CollationOptions</a></div><aside class="tsd-sources"><p>Overrides <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#collation">collation</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L29">src/operations/aggregate.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specify collation.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="comment" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> comment</h3><div class="tsd-signature tsd-kind-icon">comment<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#comment">comment</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/command.ts#L43">src/operations/command.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A user-provided comment to attach to this command</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="cursor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> cursor</h3><div class="tsd-signature tsd-kind-icon">cursor<span class="tsd-signature-symbol">?:</span> <a href="Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L23">src/operations/aggregate.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="dbName" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> db<wbr/>Name</h3><div class="tsd-signature tsd-kind-icon">db<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#dbName">dbName</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/command.ts#L48">src/operations/command.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="explain" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> explain</h3><div class="tsd-signature tsd-kind-icon">explain<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#ExplainVerbosityLike" class="tsd-signature-type" data-tsd-kind="Type alias">ExplainVerbosityLike</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#explain">explain</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/explain.ts#L25">src/explain.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specifies the verbosity mode for the explain output.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="fieldsAsRaw" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> fields<wbr/>As<wbr/>Raw</h3><div class="tsd-signature tsd-kind-icon">fields<wbr/>As<wbr/>Raw<span class="tsd-signature-symbol">?:</span> <a href="Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#fieldsAsRaw">fieldsAsRaw</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:334</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>allow to specify if there what fields we wish to return as unserialized raw buffer.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="fullResponse" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> full<wbr/>Response</h3><div class="tsd-signature tsd-kind-icon">full<wbr/>Response<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#fullResponse">fullResponse</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/command.ts#L36">src/operations/command.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>This option does nothing</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="hint" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> hint</h3><div class="tsd-signature tsd-kind-icon">hint<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#Hint" class="tsd-signature-type" data-tsd-kind="Type alias">Hint</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L31">src/operations/aggregate.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Add an index selection hint to an aggregation command</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="ignoreUndefined" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr/>Undefined</h3><div class="tsd-signature tsd-kind-icon">ignore<wbr/>Undefined<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#ignoreUndefined">ignoreUndefined</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:954</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>serialize will not emit undefined fields <strong>(default:true)</strong></p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="let" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> let</h3><div class="tsd-signature tsd-kind-icon">let<span class="tsd-signature-symbol">?:</span> <a href="Document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L33">src/operations/aggregate.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="maxAwaitTimeMS" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>Await<wbr/>TimeMS</h3><div class="tsd-signature tsd-kind-icon">max<wbr/>Await<wbr/>TimeMS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L27">src/operations/aggregate.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a name="maxTimeMS" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>TimeMS</h3><div class="tsd-signature tsd-kind-icon">max<wbr/>TimeMS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Overrides <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#maxTimeMS">maxTimeMS</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L25">src/operations/aggregate.ts:25</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="noResponse" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> no<wbr/>Response</h3><div class="tsd-signature tsd-kind-icon">no<wbr/>Response<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#noResponse">noResponse</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/command.ts#L50">src/operations/command.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="omitReadPreference" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> omit<wbr/>Read<wbr/>Preference</h3><div class="tsd-signature tsd-kind-icon">omit<wbr/>Read<wbr/>Preference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#omitReadPreference">omitReadPreference</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/operation.ts#L34">src/operations/operation.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="out" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> out</h3><div class="tsd-signature tsd-kind-icon">out<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/aggregate.ts#L34">src/operations/aggregate.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="promoteBuffers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr/>Buffers</h3><div class="tsd-signature tsd-kind-icon">promote<wbr/>Buffers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#promoteBuffers">promoteBuffers</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:330</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>when deserializing a Binary will return it as a node.js Buffer instance.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="promoteLongs" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr/>Longs</h3><div class="tsd-signature tsd-kind-icon">promote<wbr/>Longs<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#promoteLongs">promoteLongs</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:328</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>when deserializing a Long will fit it into a Number if it's smaller than 53 bits</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="promoteValues" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr/>Values</h3><div class="tsd-signature tsd-kind-icon">promote<wbr/>Values<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#promoteValues">promoteValues</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:332</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>when deserializing will promote BSON values to their Node.js closest equivalent types.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="raw" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> raw</h3><div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#raw">raw</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/bson.ts#L56">src/bson.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Return BSON filled buffers from operations</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="readConcern" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> read<wbr/>Concern</h3><div class="tsd-signature tsd-kind-icon">read<wbr/>Concern<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#ReadConcernLike" class="tsd-signature-type" data-tsd-kind="Type alias">ReadConcernLike</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#readConcern">readConcern</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/command.ts#L38">src/operations/command.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="readPreference" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> read<wbr/>Preference</h3><div class="tsd-signature tsd-kind-icon">read<wbr/>Preference<span class="tsd-signature-symbol">?:</span> <a href="../modules.html#ReadPreferenceLike" class="tsd-signature-type" data-tsd-kind="Type alias">ReadPreferenceLike</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#readPreference">readPreference</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/operation.ts#L30">src/operations/operation.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="retryWrites" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> retry<wbr/>Writes</h3><div class="tsd-signature tsd-kind-icon">retry<wbr/>Writes<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#retryWrites">retryWrites</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/command.ts#L45">src/operations/command.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Should retry failed writes</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a name="serializeFunctions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> serialize<wbr/>Functions</h3><div class="tsd-signature tsd-kind-icon">serialize<wbr/>Functions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#serializeFunctions">serializeFunctions</a></p><ul><li>Defined in node_modules/bson/bson.d.ts:952</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>serialize the javascript functions <strong>(default:false)</strong>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="session" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> session</h3><div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">?:</span> <a href="../classes/ClientSession.html" class="tsd-signature-type" data-tsd-kind="Class">ClientSession</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#session">session</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/operation.ts#L26">src/operations/operation.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Specify ClientSession for this command</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="willRetryWrites" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> will<wbr/>Retry<wbr/>Writes</h3><div class="tsd-signature tsd-kind-icon">will<wbr/>Retry<wbr/>Writes<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#willRetryWrites">willRetryWrites</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/operations/operation.ts#L27">src/operations/operation.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="writeConcern" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> write<wbr/>Concern</h3><div class="tsd-signature tsd-kind-icon">write<wbr/>Concern<span class="tsd-signature-symbol">?:</span> <a href="../classes/WriteConcern.html" class="tsd-signature-type" data-tsd-kind="Class">WriteConcern</a><span class="tsd-signature-symbol"> | </span><a href="WriteConcernSettings.html" class="tsd-signature-type" data-tsd-kind="Interface">WriteConcernSettings</a></div><aside class="tsd-sources"><p>Inherited from <a href="CommandOperationOptions.html">CommandOperationOptions</a>.<a href="CommandOperationOptions.html#writeConcern">writeConcern</a></p><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/a766f1c/src/write_concern.ts#L7">src/write_concern.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Write Concern as an object</p>
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AggregateOptions.html" class="tsd-kind-icon">Aggregate<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#allowDiskUse" class="tsd-kind-icon">allow<wbr/>Disk<wbr/>Use</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#authdb" class="tsd-kind-icon">authdb</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#batchSize" class="tsd-kind-icon">batch<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#bsonRegExp" class="tsd-kind-icon">bson<wbr/>Reg<wbr/>Exp</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#bypassDocumentValidation" class="tsd-kind-icon">bypass<wbr/>Document<wbr/>Validation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#bypassPinningCheck" class="tsd-kind-icon">bypass<wbr/>Pinning<wbr/>Check</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#checkKeys" class="tsd-kind-icon">check<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AggregateOptions.html#collation" class="tsd-kind-icon">collation</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#comment" class="tsd-kind-icon">comment</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#cursor" class="tsd-kind-icon">cursor</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#dbName" class="tsd-kind-icon">db<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#explain" class="tsd-kind-icon">explain</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#fieldsAsRaw" class="tsd-kind-icon">fields<wbr/>As<wbr/>Raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#fullResponse" class="tsd-kind-icon">full<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#hint" class="tsd-kind-icon">hint</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#ignoreUndefined" class="tsd-kind-icon">ignore<wbr/>Undefined</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#let" class="tsd-kind-icon">let</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#maxAwaitTimeMS" class="tsd-kind-icon">max<wbr/>Await<wbr/>TimeMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AggregateOptions.html#maxTimeMS" class="tsd-kind-icon">max<wbr/>TimeMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#noResponse" class="tsd-kind-icon">no<wbr/>Response</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#omitReadPreference" class="tsd-kind-icon">omit<wbr/>Read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="AggregateOptions.html#out" class="tsd-kind-icon">out</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#promoteBuffers" class="tsd-kind-icon">promote<wbr/>Buffers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#promoteLongs" class="tsd-kind-icon">promote<wbr/>Longs</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#promoteValues" class="tsd-kind-icon">promote<wbr/>Values</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#raw" class="tsd-kind-icon">raw</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#readConcern" class="tsd-kind-icon">read<wbr/>Concern</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#readPreference" class="tsd-kind-icon">read<wbr/>Preference</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#retryWrites" class="tsd-kind-icon">retry<wbr/>Writes</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="AggregateOptions.html#serializeFunctions" class="tsd-kind-icon">serialize<wbr/>Functions</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#session" class="tsd-kind-icon">session</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#willRetryWrites" class="tsd-kind-icon">will<wbr/>Retry<wbr/>Writes</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AggregateOptions.html#writeConcern" class="tsd-kind-icon">write<wbr/>Concern</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-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><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited 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-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private 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></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>