On this page
db.adminCommand()
在本页面
Definition
db.
adminCommand
(* command *)- 提供帮助程序,以对
admin
数据库运行指定的database commands。
- 提供帮助程序,以对
Parameter | Type | Description |
---|---|---|
command |
文件或字串 | database command,以document形式或字符串形式指定。如果指定为字符串,则该命令不能包含任何参数。 |
Behavior
db.adminCommand对admin
数据库运行命令,而不管它在其中运行的数据库上下文如何。以下命令是等效的:
db.getSiblingDB("admin").runCommand(<command>)
db.adminCommand(<command>)
有关可用 Management 数据库命令的列表,请参见Administration Commands。
Note
对于以authorization运行的mongod或mongos,授权用户必须具有适当的特权才能运行数据库命令。有关安全要求的更多信息,请参见命令的参考文档。
Response
该方法返回包含以下字段的响应文档:
Field | Description |
---|---|
特定于命令的结果字段 | |
ok |
一个数字,指示命令是成功(1 )还是失败(0 )。 |
operationTime |
执行的操作的逻辑时间,在 MongoDB 中用 oplog 条目中的时间戳表示。 仅适用于副本集和分片群集 |
如果该命令未生成操作日志条目,例如读操作,则该操作不会提前逻辑时钟。在这种情况下,operationTime
返回:
对于关注"local",是操作日志中最新条目的时间戳。
对于已读问题"majority"和"linearizable",是操作日志中最新majority-acknowledged项的时间戳。
对于与因果一致的会话关联的操作,MongoDB 驱动程序会利用这段时间自动设置读取操作和因果一致的会话。
3.6 版中的新功能。
| $clusterTime
|返回已签名群集时间的文档。群集时间是用于对操作进行排序的逻辑时间。 仅适用于副本集和分片群集。仅限内部使用.
该文档包含以下字段:clusterTime
:成员的已知最高群集时间的时间戳。signature
:包含集群时间的哈希值和用于签署集群时间的键的 ID 的文档。
3.6 版中的新功能。
Examples
killOp
以下示例使用db.adminCommand()方法执行killOp命令以终止opid 724
的操作。 killOp是 Management 命令,必须在admin
数据库上运行。
db.adminCommand( { "killOp": 1, "op": 724 } )
renameCollection
以下示例使用db.adminCommand()执行renameCollectionManagement 数据库命令将test
数据库中的orders
集合重命名为orders-2016
。
db.adminCommand(
{
renameCollection: "test.orders",
to: "test.orders-2016"
}
)
createUser
下面的示例使用db.adminCommand()方法在admin
数据库上创建一个具有dbOwner角色的名为bruce
的用户。
db.adminCommand(
{
createUser: "bruce",
pwd: "bruce123",
roles: [
{ role: "dbOwner", db: "admin" }
]
}
)