MongoDB\Database::aggregate()

1.5版本新增。

定义

MongoDB\Database::aggregate()

Runs a specified admin/diagnostic pipeline which does not require an underlying collection. For aggregations on collection data, see MongoDB\Collection::aggregate().

function aggregate(
    array $pipeline,
    array $options = []
): Traversable

参数

$pipeline : array

Specifies an aggregation pipeline operation.

$options : array

指定所需选项的数组。

名称	类型	说明
allowDiskUse	布尔	允许写入临时文件。设置为 `true` 时，聚合阶段可以将数据写入到 `dbPath` 目录中的 `_tmp` 子目录。
batchSize	整型	查询结果中返回的每个批处理中的最大文档数。默认下，`aggregate` 命令的初始批处理大小为 `101` 个文档，后续每个批处理的最大大小为 16 兆字节 (MiB)。此选项可以实施小于 16 MiB 的限制，但不能执行大于 MiB 的限制。如果将 `batchSize`设立为导致批量大于 16 MiB 的限制，则此选项无效。 batchSize 为 `0` 表示将建立游标，但第批处理不会返回任何文档。这对于从 `aggregate` 快速返回游标或失败结果可能很有用，而无需执行大量的服务器端工作。
bypassDocumentValidation	布尔	如果为 `true`，则允许写入操作规避文档级验证。默认为 `false`。这仅适用于使用 $out 和 $out 阶段。
编解码器	MongoDB\Codec\DocumentCodec	使用类型编解码器对数据进行编码，用于对文档进行编码或解码。此选项与 `typeMap` 选项互斥。 1.17版本新增。
排序规则	数组\|对象	Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the `locale` field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。对于服务器版本 4.4 及更高版本，评论可以是任何有效的 BSON 类型。早期服务器版本仅支持字符串值。
解释	布尔	指定是否返回有关管道处理的信息。
提示	字符串\|数组\|对象	要使用的索引。将索引名称指定为字符串或将索引键模式指定为文档。如果指定，查询系统将只考虑使用提示索引的计划。
let	数组\|对象	参数名称和值的映射。值必须是常量或不引用文档字段的封闭表达式。然后可以在聚合表达式上下文中将参数作为变量进行访问（例如 `$$var`）。 5.0 之前的服务器版本不支持此功能，如果使用，将导致执行时出现异常。 1.9版本新增。
maxTimeMS	整型	The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
事务外的	MongoDB\Driver\ReadConcern	读取关注以用于操作。默认为数据库的读关注。
readPreference	MongoDB\Driver\ReadPreference	读取要用于操作的偏好。默认为数据库的读取偏好。
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。
typeMap	阵列	应用游标的类型映射，决定如何将BSON文档转换为PHP值。默认为数据库的类型映射。
writeConcern	MongoDB\Driver\WriteConcern	Write concern to use for the operation. Defaults to the database's write concern.

Return Values

MongoDB\ 驱动程序\Cursor 或 ArrayIterator 对象。在这两种情况下，返回值均为 Traversable。

错误/异常

MongoDB\Exception\UnexpectedValueException ，如果来自服务器的命令响应格式错误。

MongoDB\Exception\UnsupportedException，如果所选服务器使用了选项但不支持选项（例如collation、readConcern、writeConcern）。

MongoDB\Exception\InvalidArgumentException 用于与参数或选项解析相关的错误。

MongoDB\ 驱动程序\Exception\RuntimeException 用于扩展级别的其他错误（例如连接错误）。

示例

以下聚合示例使用$currentOp聚合管道阶段列出所有正在运行的命令，然后筛选此列表以仅显示正在运行的命令操作。

<?php
$database = (new MongoDB\Client)->admin;
$cursor = $database->aggregate(
    [
        ['$currentOp' => []],
        ['$match' => ['op' => 'command']],
    ]
);

另请参阅

MongoDB\Collection::aggregate()
aggregate command reference in the MongoDB manual
MongoDB 手册中的聚合管道文档