Admin | mongodb

The Admin class is an internal class that allows convenient access to the admin functionality and commands for MongoDB.

ADMIN Cannot directly be instantiated

example

import { MongoClient } from 'mongodb';

const client = new MongoClient('mongodb://localhost:27017');
const admin = client.db().admin();
const dbInfo = await admin.listDatabases();
for (const db of dbInfo.databases) {
  console.log(db.name);
}

Hierarchy

Admin

Index

Methods

addUser

addUser(username: string): Promise<Document>
addUser(username: string, password: string): Promise<Document>
addUser(username: string, options: AddUserOptions): Promise<Document>
addUser(username: string, password: string, options: AddUserOptions): Promise<Document>
addUser(username: string, callback: Callback<Document>): void
addUser(username: string, password: string, callback: Callback<Document>): void
addUser(username: string, options: AddUserOptions, callback: Callback<Document>): void
addUser(username: string, password: string, options: AddUserOptions, callback: Callback<Document>): void

- Defined in src/admin.ts:175
Add a user to the database

Parameters
- username: string
  
  The username for the new user
Returns Promise<Document>
- Defined in src/admin.ts:176
Parameters
- username: string
- password: string
Returns Promise<Document>
- Defined in src/admin.ts:177
Parameters
- username: string
- options: AddUserOptions
Returns Promise<Document>
- Defined in src/admin.ts:178
Parameters
- username: string
- password: string
- options: AddUserOptions
Returns Promise<Document>
- Defined in src/admin.ts:180
deprecated
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
- Defined in src/admin.ts:182
deprecated
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
- Defined in src/admin.ts:184
deprecated
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
- Defined in src/admin.ts:186
deprecated
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

buildInfo

buildInfo(): Promise<Document>
buildInfo(options: CommandOperationOptions): Promise<Document>
buildInfo(callback: Callback<Document>): void
buildInfo(options: CommandOperationOptions, callback: Callback<Document>): void

- Defined in src/admin.ts:89
Retrieve the server build information

Returns Promise<Document>
- Defined in src/admin.ts:90
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:92
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:94
deprecated
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

command(command: Document): Promise<Document>
command(command: Document, options: CommandOperationOptions): Promise<Document>
command(command: Document, callback: Callback<Document>): void
command(command: Document, options: CommandOperationOptions, callback: Callback<Document>): void

- Defined in src/admin.ts:62
Execute a command

Parameters
- command: Document
  
  The command to execute
Returns Promise<Document>
- Defined in src/admin.ts:63
Parameters
- command: Document
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:65
deprecated
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
- Defined in src/admin.ts:67
deprecated
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

listDatabases

listDatabases(): Promise<ListDatabasesResult>
listDatabases(options: ListDatabasesOptions): Promise<ListDatabasesResult>
listDatabases(callback: Callback<ListDatabasesResult>): void
listDatabases(options: ListDatabasesOptions, callback: Callback<ListDatabasesResult>): void

- Defined in src/admin.ts:285
List the available databases

Returns Promise<ListDatabasesResult>
- Defined in src/admin.ts:286
Parameters
- options: ListDatabasesOptions
Returns Promise<ListDatabasesResult>
- Defined in src/admin.ts:288
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<ListDatabasesResult>
Returns void
- Defined in src/admin.ts:290
deprecated
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(): Promise<Document>
ping(options: CommandOperationOptions): Promise<Document>
ping(callback: Callback<Document>): void
ping(options: CommandOperationOptions, callback: Callback<Document>): void

- Defined in src/admin.ts:152
Ping the MongoDB server and retrieve results

Returns Promise<Document>
- Defined in src/admin.ts:153
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:155
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:157
deprecated
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

removeUser

removeUser(username: string): Promise<boolean>
removeUser(username: string, options: CommandOperationOptions): Promise<boolean>
removeUser(username: string, callback: Callback<boolean>): void
removeUser(username: string, options: CommandOperationOptions, callback: Callback<boolean>): void

- Defined in src/admin.ts:226
Remove a user from a database

Parameters
- username: string
  
  The username to remove
Returns Promise<boolean>
- Defined in src/admin.ts:227
Parameters
- username: string
- options: CommandOperationOptions
Returns Promise<boolean>
- Defined in src/admin.ts:229
deprecated
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
- Defined in src/admin.ts:231
deprecated
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

replSetGetStatus

replSetGetStatus(): Promise<Document>
replSetGetStatus(options: CommandOperationOptions): Promise<Document>
replSetGetStatus(callback: Callback<Document>): void
replSetGetStatus(options: CommandOperationOptions, callback: Callback<Document>): void

- Defined in src/admin.ts:311
Get ReplicaSet status

Returns Promise<Document>
- Defined in src/admin.ts:312
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:314
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:316
deprecated
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

serverInfo

serverInfo(): Promise<Document>
serverInfo(options: CommandOperationOptions): Promise<Document>
serverInfo(callback: Callback<Document>): void
serverInfo(options: CommandOperationOptions, callback: Callback<Document>): void

- Defined in src/admin.ts:110
Retrieve the server build information

Returns Promise<Document>
- Defined in src/admin.ts:111
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:113
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:115
deprecated
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

serverStatus

serverStatus(): Promise<Document>
serverStatus(options: CommandOperationOptions): Promise<Document>
serverStatus(callback: Callback<Document>): void
serverStatus(options: CommandOperationOptions, callback: Callback<Document>): void

- Defined in src/admin.ts:131
Retrieve this db's server status.

Returns Promise<Document>
- Defined in src/admin.ts:132
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:134
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:136
deprecated
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

validateCollection

validateCollection(collectionName: string): Promise<Document>
validateCollection(collectionName: string, options: ValidateCollectionOptions): Promise<Document>
validateCollection(collectionName: string, callback: Callback<Document>): void
validateCollection(collectionName: string, options: ValidateCollectionOptions, callback: Callback<Document>): void

- Defined in src/admin.ts:254
Validate an existing collection

Parameters
- collectionName: string
  
  The name of the collection to validate.
Returns Promise<Document>
- Defined in src/admin.ts:255
Parameters
- collectionName: string
- options: ValidateCollectionOptions
Returns Promise<Document>
- Defined in src/admin.ts:257
deprecated
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
- Defined in src/admin.ts:259
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- collectionName: string
- options: ValidateCollectionOptions
- callback: Callback<Document>
Returns void

Hierarchy

Index

Methods

Methods

addUser

Parameters

username: string

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>

Parameters

username: string

callback: Callback<Document>

Returns void

Parameters

username: string

password: string

callback: Callback<Document>

Returns void

Parameters

username: string

options: AddUserOptions

callback: Callback<Document>

Returns void

Parameters

username: string

password: string

options: AddUserOptions

callback: Callback<Document>

Returns void

buildInfo

Returns Promise<Document>

Parameters

options: CommandOperationOptions

Returns Promise<Document>

Parameters

callback: Callback<Document>

Returns void

Parameters

options: CommandOperationOptions

callback: Callback<Document>

Returns void

command

Parameters

command: Document

Returns Promise<Document>

Parameters

command: Document

options: CommandOperationOptions

Returns Promise<Document>

Parameters

command: Document

callback: Callback<Document>

Returns void

Parameters

command: Document

options: CommandOperationOptions

callback: Callback<Document>

Returns void

listDatabases

Returns Promise<ListDatabasesResult>

Parameters

options: ListDatabasesOptions

Returns Promise<ListDatabasesResult>

Parameters

callback: Callback<ListDatabasesResult>

Returns void

Parameters

options: ListDatabasesOptions