运行命令

在此页面上

Overview

执行命令
命令选项
响应
更多信息

Overview

在本指南中，您可以学习；了解如何使用C++驾驶员运行数据库命令。您可以使用数据库命令执行各种管理和诊断任务，例如获取服务器统计信息、初始化副本集或运行聚合管道。

重要

首选驱动程序方法而非数据库命令

驱动程序为许多数据库命令提供了封装方法。我们建议尽可能使用驱动程序方法，而不是执行数据库命令。

要执行管理任务，请使用 MongoDB Shell而不是C++驾驶员。在Shell内调用db.runCommand() 方法是发出数据库命令的首选方法，因为它在Shell和驱动程序之间提供了一致的接口。

执行命令

要运行数据库命令，请在 mongocxx::database实例上调用 run_command() 执行方法，并传入指定该命令和所有相关参数的文档。该方法会以 bsoncxx::document::value对象的形式返回该命令的结果。

您可以将run_command() 方法与任何数据库命令一起使用。有关数据库命令和相应参数的完整列表，请参阅MongoDB Server手册中的数据库命令。

以下示例展示如何使用 run_command() 方法在数据库上运行hello 命令，该命令会返回有关副本集当前成员角色的信息：

auto db = client["my_database"];
auto command = make_document(kvp("hello" , 1));
auto result = db.run_command(command.view());       
std::cout << bsoncxx::to_json(result) << std::endl;

{
  "topologyVersion" : {
                          "processId" : ...,
                          "counter" : ...
  },
  "hosts" : [ ... ],
  "setName" : ...,
  "setVersion" : ...,
  "isWritablePrimary" : ...,
  "secondary" :  ...,
  "primary" : ...,
  "tags" : {
              "region" : ...,
              "availabilityZone" : ...,
              "provider" : ...,
              "workloadType" : ...,
              "nodeType" : ...,
              "diskState" : ...
  },
  "me" : ...,
  "electionId" : ...,
  "lastWrite" : ...,
  "lastWriteDate" : ...,
  "majorityOpTime" : ...,
  "majorityWriteDate" : ...,
  "maxBsonObjectSize" : ...,
  "maxMessageSizeBytes" : ...,
  "maxWriteBatchSize" : ...,
  "localTime" : ...,
  "logicalSessionTimeoutMinutes" : ...,
  "connectionId" : ...,
  "minWireVersion" : ...,
  "maxWireVersion" : ...,
  "readOnly" : ...,
  "ok" : ...,
  "$clusterTime" : ...,
  "signature" : ...
 }

命令选项

要自定义命令执行行为，可以在传递给run_command() 方法的命令文档中设立选项。要学习；了解有关命令及其接受的选项的更多信息，请找到该命令并点击MongoDB Server手册中数据库命令页面上的相应链接。

示例，您可以通过在命令文档中将 showPrivileges 选项设置为 true，指示 connectionStatus 命令返回当前经过身份验证的用户拥有的完整权限设立：

auto db = client["my_database"];
auto command = make_document(kvp("connectionStatus" , 1), kvp("showPrivileges", true));
auto result = db.run_command(command.view());
std::cout << bsoncxx::to_json(result) << std::endl;

{
  "authInfo" : { "authenticatedUsers" : [ { "user" : ..., "db" : ... } ],
  "authenticatedUserRoles" : [ { "role" : ..., "db" : ... } ],
  "authenticatedUserPrivileges" : [
                                    { "resource" : { "db" : "", "collection" : "" }, "actions" : [ ... ] },
                                    { "resource" : { "db" : "config", "collection" : "system.sessions" }, "actions" : [ ... ] },
                                    ...,
                                    { "resource" : { "db" : "", "collection" : "" }, "actions" : [ ... ] }
  ]
},
   "ok" : 1
}

响应

执行命令后，run_command() 方法会返回一个 bsoncxx::document::value对象，其中包含数据库的响应。每个数据库命令执行不同的功能，因此响应内容可能因命令而异。但是，每个响应都包含具有以下字段的文档：

字段	说明
<command result>	提供特定于数据库命令的字段。例如， `count`返回`n`字段， `explain`返回`queryPlanner`字段。
`ok`	表明命令是成功（`1`）还是失败（`0`）。
`operationTime`	指示操作的逻辑时间。 MongoDB 使用逻辑时间对操作进行排序。
`$clusterTime`	提供返回签名集群时间的文档。集群时间是用于操作排序的逻辑时间。该文档包含以下字段： `clusterTime`，这是节点的已知最高集群时间的时间戳。 `signature`，这是一个文档，其中包含集群时间的哈希值以及用于对集群时间进行签名的密钥的 ID。