Skip to content

Commit c646624

Browse files
durrangithub-actions[bot]
durran
authored and
github-actions[bot]
committed
[create-pull-request] automated change
1 parent 9111f98 commit c646624

File tree

57 files changed

+255
-249
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+255
-249
lines changed

Diff for: ‎docs/Next/classes/Collection.html

+1-1
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoAPIError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoAWSError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoAzureError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoBatchReExecutionError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoBulkWriteError.html

+6-6
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoChangeStreamError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoClientBulkWriteCursorError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoClientBulkWriteError.html

+9-9
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoClientBulkWriteExecutionError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCompatibilityError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCryptAzureKMSRequestError.html

+4-4
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCryptCreateDataKeyError.html

+4-4
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCryptCreateEncryptedCollectionError.html

+4-4
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCryptError.html

+4-4
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCryptInvalidArgumentError.html

+4-4
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCryptKMSRequestNetworkTimeoutError.html

+4-4
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCursorExhaustedError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoCursorInUseError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoDecompressionError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoDriverError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoExpiredSessionError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoGCPError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoGridFSChunkError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoGridFSStreamError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoInvalidArgumentError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoKerberosError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoMissingCredentialsError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoMissingDependencyError.html

+6-6
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoNetworkError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoNetworkTimeoutError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoNotConnectedError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoOIDCError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoOperationTimeoutError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoParseError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoRuntimeError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoServerClosedError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoServerError.html

+6-6
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoServerSelectionError.html

+6-6
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoStalePrimaryError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoSystemError.html

+6-6
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoTailableCursorError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoTopologyClosedError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoTransactionError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoUnexpectedServerResponseError.html

+5-5
Large diffs are not rendered by default.

Diff for: ‎docs/Next/classes/MongoWriteConcernError.html

+7-7
Large diffs are not rendered by default.

Diff for: ‎docs/Next/interfaces/ErrorDescription.html

+2-2
Large diffs are not rendered by default.

Diff for: ‎docs/Next/interfaces/MongoNetworkErrorOptions.html

+2-2
Large diffs are not rendered by default.

Diff for: ‎docs/Next/interfaces/WriteConcernErrorResult.html

+2-2
Large diffs are not rendered by default.

Diff for: ‎docs/Next/types/DistinctOptions.html

+7-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DistinctOptions | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mongodb</a></li><li><a href="DistinctOptions.html">DistinctOptions</a></li></ul><h1>Type Alias DistinctOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Distinct<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type tsd-kind-interface">CommandOperationOptions</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/operations/distinct.ts#L11">src/operations/distinct.ts:11</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-alpha" name="alpha"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Alpha</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-beta" name="beta"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Beta</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>mongodb</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DistinctOptions | 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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">mongodb</a></li><li><a href="DistinctOptions.html">DistinctOptions</a></li></ul><h1>Type Alias DistinctOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Distinct<wbr/>Options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CommandOperationOptions.html" class="tsd-signature-type tsd-kind-interface">CommandOperationOptions</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">hint</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type tsd-kind-interface">Document</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hint</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/BSON.Document.html" class="tsd-signature-type tsd-kind-interface">Document</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Since Server Version" class="tsd-anchor"></a>Since Server Version<a href="#Since Server Version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>7.1</p>
2+
<p>The index to use. Specify either the index name as a string or the index key pattern.
3+
If specified, then the query system will only consider plans using the hinted index.</p>
4+
<p>If provided as a string, <code>hint</code> must be index name for an index on the collection.
5+
If provided as an object, <code>hint</code> must be an index description for an index defined on the collection.</p>
6+
<p>See <a href="https://www.mongodb.com/docs/manual/reference/command/distinct/#command-fields" target="_blank" class="external">https://www.mongodb.com/docs/manual/reference/command/distinct/#command-fields</a>.</p>
7+
</div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/main/src/operations/distinct.ts#L11">src/operations/distinct.ts:11</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-alpha" name="alpha"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Alpha</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-beta" name="beta"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Beta</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>mongodb</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

0 commit comments

Comments
 (0)