运行数据库命令

Overview

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

执行命令

要运行数据库命令，必须在命令文档中指定该命令和所有相关参数，然后将该命令文档传递给MongoDB\Database::command()方法。 许多数据库命令会返回多个结果文档，因此command() 方法会返回 MongoDB\ 驱动程序\Cursor 您可以遍历的对象。

以下代码展示如何在 MongoDB\Database实例上使用command()方法来运行hello命令，该命令会返回有关服务器的信息：

$database = $client->selectDatabase('myDB');
$cursor = $database->command(['hello' => 1]);

要查找数据库命令和相应参数的完整列表的链接，请参阅“其他信息”部分。

$readPref = new MongoDB\Driver\ReadPreference('primaryPreferred');
$cursor = $database->command(
    ['hello' => 1], 
    ['readPreference' => $readPref]
);

响应

command()方法返回一个Cursor对象，其中包含数据库对给定命令的响应。 每个数据库命令执行不同的功能，因此响应内容可能会有所不同。

对于返回单个结果文档的命令，该结果可作为游标中的第一个也是唯一一个文档。 对于返回多个结果文档的命令，该库会将原始命令响应中的游标信封（包括游标ID和第批处理结果）转换为可迭代游标。

在运行命令之前，请学习；了解该命令的响应格式，以便应用程序遍历多个结果或提取游标中的第一个也是唯一一个文档。 请参阅本指南的“其他信息”部分，找到数据库命令完整列表的链接。

原始命令响应包含以下字段：

命令示例

以下示例使用command()方法运行dbStats命令，以检索accounts数据库的存储统计信息：

$database = $client->accounts;
$command = ['dbStats' => 1];
// dbStats returns a single document
$cursor = $database->command($command);
// Print the first document in the cursor
echo json_encode($cursor->toArray()[0]), PHP_EOL;

此命令的输出包括有关数据库中集合的信息，并描述跨集合存储的数据量和大小：

{"db":"accounts","collections":2,"views":0,"objects":5,"avgObjSize":22,"dataSize":110,
"storageSize":40960,"totalFreeStorageSize":0,"numExtents":0,"indexes":2,"indexSize":40960,
"indexFreeStorageSize":0,"fileSize":0,"nsSizeMB":0,"ok":1}

更多信息

有关本指南中概念的更多信息，请参阅MongoDB Server手册中的以下文档：

• db.runCommand()

• 数据库命令

• hello 命令

• dbStats 命令