From 86a614a3809874aab16540627740543462daf37d Mon Sep 17 00:00:00 2001 From: durran <9030+durran@users.noreply.github.com> Date: Tue, 17 Sep 2024 13:41:42 +0000 Subject: [PATCH] [create-pull-request] automated change --- docs/404.html | 14 +- docs/Next/assets/navigation.js | 2 +- docs/Next/assets/search.js | 2 +- docs/Next/classes/AggregationCursor.html | 2 +- docs/Next/classes/Db.html | 2 +- docs/Next/classes/FindCursor.html | 2 +- docs/Next/classes/HostAddress.html | 4 +- .../Next/classes/ListSearchIndexesCursor.html | 2 +- docs/Next/classes/MongoCredentials.html | 18 +- .../classes/MongoDBCollectionNamespace.html | 8 +- docs/Next/classes/MongoDBNamespace.html | 8 +- docs/Next/classes/WriteConcern.html | 19 +- docs/Next/interfaces/AggregateOptions.html | 6 +- .../interfaces/AggregationCursorOptions.html | 6 +- .../interfaces/AuthMechanismProperties.html | 12 +- docs/Next/interfaces/BulkWriteOptions.html | 6 +- docs/Next/interfaces/ChangeStreamOptions.html | 6 +- .../interfaces/CommandOperationOptions.html | 6 +- .../interfaces/CountDocumentsOptions.html | 6 +- docs/Next/interfaces/CountOptions.html | 6 +- .../interfaces/CreateCollectionOptions.html | 6 +- .../Next/interfaces/CreateIndexesOptions.html | 6 +- docs/Next/interfaces/DbStatsOptions.html | 6 +- docs/Next/interfaces/DeleteOptions.html | 6 +- .../interfaces/DropCollectionOptions.html | 6 +- .../EstimatedDocumentCountOptions.html | 6 +- .../interfaces/ExplainCommandOptions.html | 5 + docs/Next/interfaces/ExplainOptions.html | 18 +- .../interfaces/FindOneAndDeleteOptions.html | 6 +- .../interfaces/FindOneAndReplaceOptions.html | 6 +- .../interfaces/FindOneAndUpdateOptions.html | 6 +- docs/Next/interfaces/FindOptions.html | 6 +- docs/Next/interfaces/InsertOneOptions.html | 6 +- .../interfaces/ListCollectionsOptions.html | 6 +- .../Next/interfaces/ListDatabasesOptions.html | 6 +- docs/Next/interfaces/MongoClientOptions.html | 4 +- .../interfaces/MongoCredentialsOptions.html | 4 +- docs/Next/interfaces/RenameOptions.html | 6 +- docs/Next/interfaces/ReplaceOptions.html | 6 +- docs/Next/interfaces/TransactionOptions.html | 6 +- docs/Next/interfaces/UpdateOptions.html | 6 +- .../interfaces/ValidateCollectionOptions.html | 6 +- docs/Next/modules.html | 1 + docs/Next/types/EventEmitterWithState.html | 2 +- docs/Next/types/ExplainVerbosity.html | 2 +- docs/Next/types/ExplainVerbosityLike.html | 5 +- docs/Next/variables/ExplainVerbosity-1.html | 2 +- docs/categories/index.xml | 5 +- docs/index.html | 420 +++++++++--------- docs/index.xml | 5 +- docs/tags/index.xml | 5 +- 51 files changed, 369 insertions(+), 354 deletions(-) create mode 100644 docs/Next/interfaces/ExplainCommandOptions.html diff --git a/docs/404.html b/docs/404.html index 665301be229..ef939e8cf63 100644 --- a/docs/404.html +++ b/docs/404.html @@ -21,16 +21,16 @@
- +Execute the explain for the cursor
-Optional
verbosity: ExplainVerbosityLikeIterates over all the documents for this cursor using the iterator, callback pattern.
+Optional
verbosity: ExplainVerbosityLike | ExplainCommandOptionsIterates over all the documents for this cursor using the iterator, callback pattern.
If the iterator returns false
, iteration will stop.
Check if a secondary can be used (because the read preference is not set to primary)
Execute an aggregation framework pipeline against the database, needs MongoDB >= 3.6
+Execute an aggregation framework pipeline against the database.
An array of aggregation stages to be executed
Optional
options: AggregateOptionsOptional settings for the command
Returns a reference to a MongoDB Collection. If it does not exist it will be created implicitly.
diff --git a/docs/Next/classes/FindCursor.html b/docs/Next/classes/FindCursor.html index 9e842bb6888..910c9d43b76 100644 --- a/docs/Next/classes/FindCursor.html +++ b/docs/Next/classes/FindCursor.html @@ -151,7 +151,7 @@Execute the explain for the cursor
-Optional
verbosity: ExplainVerbosityLikeSet the cursor query
+Optional
verbosity: ExplainVerbosityLike | ExplainCommandOptionsSet the cursor query
Iterates over all the documents for this cursor using the iterator, callback pattern.
If the iterator returns false
, iteration will stop.
The iteration callback.
diff --git a/docs/Next/classes/HostAddress.html b/docs/Next/classes/HostAddress.html index a5f238a5fd6..58798901137 100644 --- a/docs/Next/classes/HostAddress.html +++ b/docs/Next/classes/HostAddress.html @@ -1,4 +1,4 @@ -Static
fromStatic
fromStatic
fromStatic
fromStatic
fromStatic
fromExecute the explain for the cursor
-Optional
verbosity: ExplainVerbosityLikeIterates over all the documents for this cursor using the iterator, callback pattern.
+Optional
verbosity: ExplainVerbosityLike | ExplainCommandOptionsIterates over all the documents for this cursor using the iterator, callback pattern.
If the iterator returns false
, iteration will stop.
The iteration callback.
A representation of the credentials used by MongoDB
-Readonly
mechanismThe method used to authenticate
-Readonly
mechanismSpecial properties used by some types of auth mechanisms
-Readonly
passwordThe password used for authentication
-Readonly
sourceThe database that the user should authenticate against
-Readonly
usernameThe username used for authentication
-Determines if two MongoCredentials objects are equivalent
-If the authentication mechanism is set to "default", resolves the authMechanism +
Readonly
mechanismThe method used to authenticate
+Readonly
mechanismSpecial properties used by some types of auth mechanisms
+Readonly
passwordThe password used for authentication
+Readonly
sourceThe database that the user should authenticate against
+Readonly
usernameThe username used for authentication
+Determines if two MongoCredentials objects are equivalent
+If the authentication mechanism is set to "default", resolves the authMechanism based on the server version and server supported sasl mechanisms.
A hello response from the server
-Static
mergeStatic
merge
Since
v6.0.0