Class: Admin

Methods

addUser(username, password, options, callback){Promise}

lib/admin.js, line 180

Add a user to the database.

Name	Type	Description
username	string	The username.
password	string	The password.
options	object	optional Optional settings. Name Type Default Description w number | string optional Deprecated The write concern. Use writeConcern instead. wtimeout number optional Deprecated The write concern timeout. Use writeConcern instead. j boolean false optional Deprecated Specify a journal write concern. Use writeConcern instead. fsync boolean false optional Deprecated Specify a file sync write concern. Use writeConcern instead. writeConcern object | WriteConcern optional Specify write concern settings. customData object optional Custom data associated with the user (only Mongodb 2.6 or higher) roles Array.<object> optional Roles associated with the created user (only Mongodb 2.6 or higher) session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback

Returns:

Promise if no callback passed

buildInfo(options, callback){Promise}

lib/admin.js, line 92

Retrieve the server information for the current
instance of the db client

Name	Type	Description
options	Object	optional optional parameters for this operation Name Type Description session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback

Returns:

Promise if no callback passed

command(command, options, callback){Promise}

lib/admin.js, line 73

Execute a command

Name	Type	Description
command	object	The command hash
options	object	optional Optional settings. Name Type Description readPreference ReadPreference | string optional The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). maxTimeMS number optional Number of milliseconds to wait before aborting the query.
callback	Admin~resultCallback	optional The command result callback

Returns:

Promise if no callback passed

listDatabases(options, callback){Promise}

lib/admin.js, line 264

List the available databases

Name	Type	Description
options	object	optional Optional settings. Name Type Default Description nameOnly boolean false optional Whether the command should return only db names, or names and size info. session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback.

Returns:

Promise if no callback passed

ping(options, callback){Promise}

lib/admin.js, line 152

Ping the MongoDB server and retrieve results

Name	Type	Description
options	Object	optional optional parameters for this operation Name Type Description session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback

Returns:

Promise if no callback passed

removeUser(username, options, callback){Promise}

lib/admin.js, line 216

Remove a user from a database

Name	Type	Description
username	string	The username.
options	object	optional Optional settings. Name Type Default Description w number | string optional Deprecated The write concern. Use writeConcern instead. wtimeout number optional Deprecated The write concern timeout. Use writeConcern instead. j boolean false optional Deprecated Specify a journal write concern. Use writeConcern instead. fsync boolean false optional Deprecated Specify a file sync write concern. Use writeConcern instead. writeConcern object | WriteConcern optional Specify write concern settings. session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback

Returns:

Promise if no callback passed

replSetGetStatus(options, callback){Promise}

lib/admin.js, line 283

Get ReplicaSet status

Name	Type	Description
options	Object	optional optional parameters for this operation Name Type Description session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback.

Returns:

Promise if no callback passed

serverInfo(options, callback){Promise}

lib/admin.js, line 112

Retrieve the server information for the current
instance of the db client

Name	Type	Description
options	Object	optional optional parameters for this operation Name Type Description session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback

Returns:

Promise if no callback passed

serverStatus(options, callback){Promise}

lib/admin.js, line 131

Retrieve this db's server status.

Name	Type	Description
options	Object	optional optional parameters for this operation Name Type Description session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback

Returns:

Promise if no callback passed

validateCollection(collectionName, options, callback){Promise}

lib/admin.js, line 242

Validate an existing collection

Name	Type	Description
collectionName	string	The name of the collection to validate.
options	object	optional Optional settings. Name Type Description background boolean optional Validates a collection in the background, without interrupting read or write traffic (only in MongoDB 4.4+) session ClientSession optional optional session to use for this operation
callback	Admin~resultCallback	optional The command result callback.

Returns:

Promise if no callback passed

Type Definitions

resultCallback(error, result)

lib/admin.js, line 56

The callback format for results

Name	Type	Description
error	MongoError	An error instance representing the error during the execution.
result	object	The result object if the command was executed successfully.