From 9958879c2d9c7b594c581cbf69bac364933b2155 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 15 Nov 2022 17:28:52 -0500 Subject: [PATCH] docs: generate docs from latest main (#3462) --- docs/Next/classes/Admin.html | 64 +++---- docs/Next/classes/AggregationCursor.html | 11 +- docs/Next/classes/ClientSession.html | 6 +- docs/Next/classes/Collection.html | 211 +++++++++++------------ docs/Next/classes/Db.html | 76 ++++---- docs/Next/classes/FindCursor.html | 14 +- docs/Next/classes/Logger.html | 29 ++-- docs/Next/classes/MongoClient.html | 12 +- 8 files changed, 212 insertions(+), 211 deletions(-) diff --git a/docs/Next/classes/Admin.html b/docs/Next/classes/Admin.html index b4bb1e76fb..d59899c079 100644 --- a/docs/Next/classes/Admin.html +++ b/docs/Next/classes/Admin.html @@ -4,54 +4,54 @@
ADMIN Cannot directly be instantiated
Generated using TypeDoc
Hierarchy
Index
Methods
Methods
add User
Add a user to the database
Parameters
username: string
The username for the new user
-Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
username: string
callback: Callback<Document>
Returns void
Parameters
username: string
password: string
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
username: string
password: string
callback: Callback<Document>
Returns void
Parameters
username: string
options: AddUserOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
username: string
options: AddUserOptions
callback: Callback<Document>
Returns void
Parameters
username: string
password: string
options: AddUserOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
username: string
password: string
options: AddUserOptions
callback: Callback<Document>
Returns void
build Info
Returns Promise<Document>
Parameters
username: string
password: string
Returns Promise<Document>
Parameters
username: string
options: AddUserOptions
Returns Promise<Document>
Parameters
username: string
password: string
options: AddUserOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
username: string
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
username: string
password: string
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
username: string
options: AddUserOptions
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
username: string
password: string
options: AddUserOptions
callback: Callback<Document>
Returns void
build Info
Retrieve the server build information
-Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
callback: Callback<Document>
Returns void
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
command
Returns Promise<Document>
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
command
Execute a command
Parameters
command: Document
The command to execute
-Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
command: Document
callback: Callback<Document>
Returns void
Parameters
command: Document
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
command: Document
options: CommandOperationOptions
callback: Callback<Document>
Returns void
list Databases
Returns Promise<Document>
Parameters
command: Document
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
command: Document
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
command: Document
options: CommandOperationOptions
callback: Callback<Document>
Returns void
list Databases
List the available databases
-Returns Promise<ListDatabasesResult>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
callback: Callback<ListDatabasesResult>
Returns void
Parameters
options: ListDatabasesOptions
Returns Promise<ListDatabasesResult>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
options: ListDatabasesOptions
callback: Callback<ListDatabasesResult>
Returns void
ping
Returns Promise<ListDatabasesResult>
Parameters
options: ListDatabasesOptions
Returns Promise<ListDatabasesResult>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
callback: Callback<ListDatabasesResult>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
options: ListDatabasesOptions
callback: Callback<ListDatabasesResult>
Returns void
ping
Ping the MongoDB server and retrieve results
-Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
callback: Callback<Document>
Returns void
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
remove User
Returns Promise<Document>
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
remove User
Remove a user from a database
Parameters
username: string
The username to remove
-Returns Promise<boolean>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
username: string
callback: Callback<boolean>
Returns void
Parameters
username: string
options: CommandOperationOptions
Returns Promise<boolean>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
username: string
options: CommandOperationOptions
callback: Callback<boolean>
Returns void
repl Set Get Status
Returns Promise<boolean>
Parameters
username: string
options: CommandOperationOptions
Returns Promise<boolean>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
username: string
callback: Callback<boolean>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
username: string
options: CommandOperationOptions
callback: Callback<boolean>
Returns void
repl Set Get Status
Get ReplicaSet status
-Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
callback: Callback<Document>
Returns void
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
server Info
Returns Promise<Document>
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
server Info
Retrieve the server build information
-Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
callback: Callback<Document>
Returns void
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
server Status
Returns Promise<Document>
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
server Status
Retrieve this db's server status.
-Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
callback: Callback<Document>
Returns void
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
validate Collection
Returns Promise<Document>
Parameters
options: CommandOperationOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
callback: Callback<Document>
Returns void
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+Parameters
options: CommandOperationOptions
callback: Callback<Document>
Returns void
validate Collection
Validate an existing collection
Parameters
collectionName: string
The name of the collection to validate.
-Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
-Parameters
collectionName: string
callback: Callback<Document>
Returns void
Parameters
collectionName: string
options: ValidateCollectionOptions
Returns Promise<Document>
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance
+