Class Admin

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

const MongoClient = require('mongodb').MongoClient;
const test = require('assert');
// Connection url
const url = 'mongodb://localhost:27017';
// Database Name
const dbName = 'test';

// Connect using MongoClient
MongoClient.connect(url, function(err, client) {
  // Use the admin database for the operation
  const adminDb = client.db(dbName).admin();

  // List all the available databases
  adminDb.listDatabases(function(err, dbs) {
    expect(err).to.not.exist;
    test.ok(dbs.databases.length > 0);
    client.close();
  });
});

Hierarchy

Admin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Admin(db: Db): Admin

- Defined in src/admin.ts:56
Create a new Admin instance

internal

Parameters
- db: Db
Returns Admin

Properties

s

s: AdminPrivate

internal

Methods

addUser

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

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

Parameters
- username: string
  
  The username for the new user
Returns Promise<Document>
- Defined in src/admin.ts:177
Parameters
- username: string
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:178
Parameters
- username: string
- password: string
Returns Promise<Document>
- Defined in src/admin.ts:179
Parameters
- username: string
- password: string
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:180
Parameters
- username: string
- options: AddUserOptions
Returns Promise<Document>
- Defined in src/admin.ts:181
Parameters
- username: string
- options: AddUserOptions
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:182
Parameters
- username: string
- password: string
- options: AddUserOptions
Returns Promise<Document>
- Defined in src/admin.ts:183
Parameters
- username: string
- password: string
- options: AddUserOptions
- callback: Callback<Document>
Returns void

buildInfo

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

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

Returns Promise<Document>
- Defined in src/admin.ts:99
Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:100
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:101
Parameters
- options: CommandOperationOptions
- callback: Callback<Document>
Returns void

command

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

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

Parameters
- command: Document
  
  The command to execute
Returns Promise<Document>
- Defined in src/admin.ts:74
Parameters
- command: Document
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:75
Parameters
- command: Document
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:76
Parameters
- command: Document
- options: CommandOperationOptions
- callback: Callback<Document>
Returns void

listDatabases

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

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

Returns Promise<ListDatabasesResult>
- Defined in src/admin.ts:279
Parameters
- callback: Callback<ListDatabasesResult>
Returns void
- Defined in src/admin.ts:280
Parameters
- options: ListDatabasesOptions
Returns Promise<ListDatabasesResult>
- Defined in src/admin.ts:281
Parameters
- options: ListDatabasesOptions
- callback: Callback<ListDatabasesResult>
Returns void

ping

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

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

Returns Promise<Document>
- Defined in src/admin.ts:156
Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:157
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:158
Parameters
- options: CommandOperationOptions
- callback: Callback<Document>
Returns void

removeUser

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

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

Parameters
- username: string
  
  The username to remove
Returns Promise<boolean>
- Defined in src/admin.ts:224
Parameters
- username: string
- callback: Callback<boolean>
Returns void
- Defined in src/admin.ts:225
Parameters
- username: string
- options: CommandOperationOptions
Returns Promise<boolean>
- Defined in src/admin.ts:226
Parameters
- username: string
- options: CommandOperationOptions
- callback: Callback<boolean>
Returns void

replSetGetStatus

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

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

Returns Promise<Document>
- Defined in src/admin.ts:303
Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:304
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:305
Parameters
- options: CommandOperationOptions
- callback: Callback<Document>
Returns void

serverInfo

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

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

Returns Promise<Document>
- Defined in src/admin.ts:118
Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:119
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:120
Parameters
- options: CommandOperationOptions
- callback: Callback<Document>
Returns void

serverStatus

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

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

Returns Promise<Document>
- Defined in src/admin.ts:137
Parameters
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:138
Parameters
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/admin.ts:139
Parameters
- options: CommandOperationOptions
- callback: Callback<Document>
Returns void

validateCollection

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

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

Parameters
- collectionName: string
  
  The name of the collection to validate.
Returns Promise<Document>
- Defined in src/admin.ts:250
Parameters
- collectionName: string
- callback: Callback<Document>
Returns void
- Defined in src/admin.ts:251
Parameters
- collectionName: string
- options: ValidateCollectionOptions
Returns Promise<Document>
- Defined in src/admin.ts:252
Parameters
- collectionName: string
- options: ValidateCollectionOptions
- callback: Callback<Document>
Returns void

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: Db

Returns Admin

Properties

s

Methods

addUser

Parameters

username: string

Returns Promise<Document>

Parameters

username: string

callback: Callback<Document>

Returns void

Parameters

username: string

password: string

Returns Promise<Document>

Parameters

username: string

password: string

callback: Callback<Document>

Returns void

Parameters

username: string

options: AddUserOptions

Returns Promise<Document>

Parameters

username: string

options: AddUserOptions

callback: Callback<Document>

Returns void

Parameters

username: string

password: string

options: AddUserOptions

Returns Promise<Document>

Parameters

username: string

password: string

options: AddUserOptions

callback: Callback<Document>

Returns void

buildInfo

Returns Promise<Document>

Parameters

callback: Callback<Document>

Returns void

Parameters

options: CommandOperationOptions

Returns Promise<Document>

Parameters

options: CommandOperationOptions

callback: Callback<Document>

Returns void

command

Parameters

command: Document

Returns Promise<Document>

Parameters

command: Document

callback: Callback<Document>

Returns void

Parameters

command: Document

options: CommandOperationOptions

Returns Promise<Document>

Parameters

command: Document

options: CommandOperationOptions

callback: Callback<Document>

Returns void

listDatabases