Admin | mongodb

~~The Admin class is an internal class that allows convenient access to the admin functionality and commands for MongoDB.~~Admin类是一个内部类，允许方便地访问MongoDB的管理功能和命令。

~~ADMIN Cannot directly be instantiated~~ADMIN无法直接实例化

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, 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:175
~~Add a user to the database~~将用户添加到数据库

~~Parameters~~参数
- username: string
  
  ~~The username for the new user~~新用户的用户名
~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:177
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~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:180
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- username: string
- password: string
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:181
~~Parameters~~参数
- username: string
- options: AddUserOptions
~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:183
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- username: string
- options: AddUserOptions
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:184
~~Parameters~~参数
- username: string
- password: string
- options: AddUserOptions
~~Returns~~ 返回 Promise<Document>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:89
~~Retrieve the server build information~~检索服务器生成信息

~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:91
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:92
~~Parameters~~参数
- options: CommandOperationOptions
~~Returns~~ 返回 Promise<Document>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:62
~~Execute a command~~执行命令

~~Parameters~~参数
- command: Document
  
  ~~The command to execute~~要执行的命令
~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:64
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- command: Document
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:65
~~Parameters~~参数
- command: Document
- options: CommandOperationOptions
~~Returns~~ 返回 Promise<Document>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:285
~~List the available databases~~列出可用数据库

~~Returns~~ 返回 Promise<ListDatabasesResult>
- ~~Defined in~~ 定义位于src/admin.ts:287
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- callback: Callback<ListDatabasesResult>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:288
~~Parameters~~参数
- options: ListDatabasesOptions
~~Returns~~ 返回 Promise<ListDatabasesResult>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:152
~~Ping the MongoDB server and retrieve results~~Ping MongoDB服务器并检索结果

~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:154
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:155
~~Parameters~~参数
- options: CommandOperationOptions
~~Returns~~ 返回 Promise<Document>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:226
~~Remove a user from a database~~从数据库中删除用户

~~Parameters~~参数
- username: string
  
  The username to remove
~~Returns~~ 返回 Promise<boolean>
- ~~Defined in~~ 定义位于src/admin.ts:228
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- username: string
- callback: Callback<boolean>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:229
~~Parameters~~参数
- username: string
- options: CommandOperationOptions
~~Returns~~ 返回 Promise<boolean>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:311
~~Get ReplicaSet status~~获取副本集状态

~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:313
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:314
~~Parameters~~参数
- options: CommandOperationOptions
~~Returns~~ 返回 Promise<Document>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:110
~~Retrieve the server build information~~检索服务器生成信息

~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:112
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:113
~~Parameters~~参数
- options: CommandOperationOptions
~~Returns~~ 返回 Promise<Document>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:131
~~Retrieve this db's server status.~~检索此数据库的服务器状态。

~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:133
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:134
~~Parameters~~参数
- options: CommandOperationOptions
~~Returns~~ 返回 Promise<Document>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~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:254
~~Validate an existing collection~~验证现有集合

~~Parameters~~参数
- collectionName: string
  
  ~~The name of the collection to validate.~~要验证的集合的名称。
~~Returns~~ 返回 Promise<Document>
- ~~Defined in~~ 定义位于src/admin.ts:256
deprecated
~~Callbacks are deprecated and will be removed in the next major version.~~ 回调已被弃用，将在下一个主要版本中删除。~~See mongodb-legacy for migration assistance~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- collectionName: string
- callback: Callback<Document>
~~Returns~~ 返回 void
- ~~Defined in~~ 定义位于src/admin.ts:257
~~Parameters~~参数
- collectionName: string
- options: ValidateCollectionOptions
~~Returns~~ 返回 Promise<Document>
- ~~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~~请参阅mongodb-legacy获取迁移帮助

~~Parameters~~参数
- collectionName: string
- options: ValidateCollectionOptions
- callback: Callback<Document>
~~Returns~~ 返回 void

Hierarchy继承层级

Index索引

Methods方法

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

Returns 返回 Promise<ListDatabasesResult>

Parameters参数

callback: Callback<ListDatabasesResult>

Returns 返回 void

Parameters参数

options: ListDatabasesOptions

Returns 返回 Promise<ListDatabasesResult>

Parameters参数

options: ListDatabasesOptions