Important
mongosh Method方法
This page documents a 本页记录了一种mongosh method. This is not the documentation for a language-specific driver, such as Node.js.mongosh方法。这不是针对特定语言驱动程序（如Node.js）的文档。
For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.有关MongoDB API驱动程序，请参阅特定语言的MongoDB驱动程序文档。
Definition定义
db.adminCommand(command)Provides a helper to run specified database commands against the提供一个帮助程序，用于对admindatabase.admin数据库运行指定的数据库命令。Parameter参数Type类型Description描述commanddocument or string文档或字符串A database command, specified either in document form or as a string. If specified as a string, the command cannot include any arguments.
Compatibility兼容性
This method is available in deployments hosted in the following environments:此方法在以下环境中托管的部署中可用：
- MongoDB Atlas
: The fully managed service for MongoDB deployments in the cloud：云中MongoDB部署的完全托管服务
Note
This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.所有MongoDB Atlas集群都支持此命令。有关Atlas支持所有命令的信息，请参阅不支持的命令。
- MongoDB Enterprise
: The subscription-based, self-managed version of MongoDB：MongoDB的基于订阅的自我管理版本 - MongoDB Community
: The source-available, free-to-use, and self-managed version of MongoDB：MongoDB的源代码可用、免费使用和自我管理版本
Behavior行为
db.adminCommand() runs commands against the admin database regardless of the database context in which it runs. The following commands are equivalent:
db.getSiblingDB("admin").runCommand(<command>)
db.adminCommand(<command>)For a list of available administrative database commands, see Administration Commands.
Note
For a mongod or mongos running with authorization, the authorized user must have the appropriate privileges to run the database command. See the reference documentation for the command for more information on security requirements.
Response
The method returns a response document that contains the following fields:
| <command result> | Result fields specific to the command that ran. |
ok | A number that indicates if the command succeeded (1) or failed (0). |
operationTime | The logical time of the operation. MongoDB uses the logical time to order operations. Only for replica sets and sharded clusters. If the command does not generate an oplog entry, for example, a read operation, then the operation does not advance the logical clock. In this case,
For operations associated with causally consistent sessions, the MongoDB drivers use the logical time to automatically set the Read Operations and |
$clusterTime | A document that returns the signed cluster time. Cluster time is a logical time used for ordering of operations. Only for replica sets and sharded clusters. For internal use only. The document contains the following fields:
|
Examples示例
killOp
The following example uses the db.adminCommand() method to execute a killOp command to terminate an operation with opid 724. killOp is an administrative command and must be run against the admin database.
db.adminCommand( { "killOp": 1, "op": 724 } )renameCollection
The following example uses db.adminCommand() to execute the renameCollection administrative database command to rename the orders collection in the test database to orders-2016.
db.adminCommand(
{
renameCollection: "test.orders",
to: "test.orders-2016"
}
)createUser
The following example uses the db.adminCommand() method to create a user named bruce with the dbOwner role on the admin database.
Tip
You can use the passwordPrompt() method in conjunction with various user authentication management methods and commands to prompt for the password instead of specifying the password directly in the method or command call. However, you can still specify the password directly as you would with earlier versions of the mongo shell.
db.adminCommand(
{
createUser: "bruce",
pwd: passwordPrompt(), // or <cleartext password>
roles: [
{ role: "dbOwner", db: "admin" }
]
}
)