Docs 菜单

Docs 主页 → 开发应用程序 → MongoDB Manual

db.adminCommand()

在此页面上

  • 定义
  • 行为
  • 响应
  • 举例

重要

mongosh 方法

本页介绍了 mongosh方法。这不是特定于语言的驱动程序（例如 Node.js）的文档。

对于 MongoDB API 驱动程序，请参阅特定语言的MongoDB 驱动程序文档。

定义

db.adminCommand(command)

提供针对 admin 数据库运行指定数据库命令的辅助程序。

范围
类型
说明
command
文档或字符串
以文档形式或字符串形式指定的数据库命令。如果指定为字符串，则命令不能包含任何参数。

行为

db.adminCommand()针对admin数据库运行命令，而无论其运行在什么数据库上下文中。以下命令是等效的：

db.getSiblingDB("admin").runCommand(<command>)
db.adminCommand(<command>)

有关可用管理数据库命令的列表，请参阅管理命令。

注意

对于使用 authorization 运行的 mongod 或 mongos，经过授权的用户必须拥有适当的权限才能运行此数据库命令。有关安全要求的更多信息，请参阅此命令的参考文档。

响应

该方法返回包含以下字段的响应文档：

字段
说明
<command result>
特定于运行的 command 结果字段。
ok
表明命令成功 (1) 还是失败 (0) 的数字。
operationTime

操作的逻辑时间。MongoDB 使用逻辑时间对排序操作。仅适用于副本集和分片集群。

如果命令不生成 oplog 条目，例如读操作，则该操作不会推进逻辑时钟。在这种情况下，operationTime 会返回：

对于与因果一致会话相关的操作，MongoDB 驱动程序使用逻辑时间自动设置读取操作和 afterClusterTime 周期。

$clusterTime

返回已签名集群时间的文档。集群时间是用于操作排序的逻辑时间。仅适用于副本集和分片集群。仅供内部使用。

该文档包含以下字段：

  • clusterTime：成员的已知最高集群时间的时间戳。

  • signature：一个文档，包含集群时间的哈希值和用于对集群时间进行签名的密钥 ID。

举例

killOp

以下示例使用db.adminCommand()方法执行killOp命令，以终止使用opid 724的操作。 killOp是管理命令，必须针对admin数据库运行。

db.adminCommand( { "killOp": 1, "op": 724 } )

renameCollection

以下示例使用db.adminCommand()执行renameCollection管理数据库命令，将test数据库中的orders集合重命名为orders-2016 。

db.adminCommand(
  {
     renameCollection: "test.orders",
     to: "test.orders-2016"
  }
)

createUser

以下示例使用db.adminCommand()方法在admin数据库上创建具有dbOwner角色的名为bruce的用户。

提示

您可以将passwordPrompt()方法与各种用户身份验证/管理方法/命令结合使用，以提示输入密码，而不是直接在方法/命令调用中指定密码。不过，您仍然可以像使用早期版本的mongo Shell 一样直接指定密码。

db.adminCommand(
  {
    createUser: "bruce",
    pwd: passwordPrompt(),  // or <cleartext password>
    roles: [
      { role: "dbOwner", db: "admin" }
    ]
  }
)
← 数据库方法
db.aggregate() →

在此页面上