聚合构建器

示例文档

以下示例在User模型表示的集合上运行聚合管道。您可以通过运行以下insert()方法来添加样本数据：

User::insert([
    ['name' => 'Alda Gröndal', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('2002-01-01'))],
    ['name' => 'Francois Soma', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1998-02-02'))],
    ['name' => 'Janet Doe', 'occupation' => 'designer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1987-03-03'))],
    ['name' => 'Eliud Nkosana', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1984-04-04'))],
    ['name' => 'Bran Steafan', 'occupation' => 'engineer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1998-05-05'))],
    ['name' => 'Ellis Lee', 'occupation' => 'designer', 'birthday' => new UTCDateTime(new DateTimeImmutable('1996-06-06'))],
]);

匹配阶段示例

您可以将match()方法链接到聚合管道以指定查询筛选器。如果省略此阶段， aggregate()方法将为下一阶段输出模型集合中的所有文档。

此聚合阶段通常放在第一位，以便使用可用索引检索数据，并减少后续阶段处理的数据量。

此示例使用MongoDB\Builder\Query构建器为匹配聚合阶段构造查询筛选器。匹配阶段包括以下标准：

• 使用Query::or()函数返回与任一查询筛选器匹配的结果

• 使用Query::query()和Query::eq()函数匹配包含值为"designer"的occupation字段的文档

• 使用Query::query()和Query::eq()函数匹配包含值为"Eliud Nkosana"的name字段的文档

单击 VIEW OUTPUT按钮查看运行以下代码返回的文档：

$pipeline = User::aggregate()
    ->match(Query::or(
        Query::query(occupation: Query::eq('designer')),
        Query::query(name: Query::eq('Eliud Nkosana')),
    ));
$result = $pipeline->get();

小组赛阶段示例

您可以将group()方法链接到聚合管道，通过执行计算并按公共字段值分组来修改数据结构。

此聚合阶段通常紧随匹配阶段之后放置，以减少后续阶段处理的数据。

此示例使用MongoDB\Builder\Expression构建器定义群组聚合阶段的群组键。小组赛阶段指定以下分组行为：

• 将_id字段表示的组键的值设置为Expression构建器定义的字段值

• 通过调用Expression::fieldPath()函数引用occupation字段中的文档值

单击VIEW OUTPUT按钮，查看运行代码返回的文档：

$pipeline = User::aggregate()
    ->group(_id: Expression::fieldPath('occupation'));
$result = $pipeline->get();

排序阶段示例

您可以将sort()方法链接到聚合管道，以指定文档的输出顺序。

您可以在管道中的任何位置添加此聚合阶段。它通常位于小组赛阶段之后，因为它可能取决于分组数据。我们建议在管道中尽可能晚地放置排序阶段，以限制其处理的数据。

要指定排序，请将字段值设置为Sort::Asc枚举以进行升序排序，或将Sort::Desc枚举设置为降序排序。

此示例显示了sort()聚合管道阶段，该阶段按name字段到Sort::Desc对文档进行排序，对应于反向字母顺序。单击VIEW OUTPUT按钮，查看运行代码返回的文档：

$pipeline = User::aggregate()
    ->sort(name: Sort::Desc);
$result = $pipeline->get();

项目阶段示例

您可以将project()方法链接到聚合管道，以指定此阶段要显示文档中的哪些字段。

要指定要包含的字段，请传递字段名称和真值，例如1或true 。输出中将省略所有其他字段。

或者，要指定要排除的字段，请传递每个字段名称和一个假值，例如0或false 。所有其他字段都包含在输出中。

此示例演示如何使用project()方法聚合阶段仅包含name字段并从输出中排除所有其他字段。单击VIEW OUTPUT按钮可查看运行代码返回的数据：

$pipeline = User::aggregate()
    ->project(_id: 0, name: 1);
$result = $pipeline->get();

聚合管道示例

此聚合管道示例链接了多个阶段。每个阶段都在从每个先前阶段检索的输出上运行。在此示例中，各个阶段按顺序执行以下操作：

• 将birth_year字段添加到文档中，并将值设置为从birthday字段中提取的年份。

• 按occupation字段的值对文档进行分组，并使用Accumulator::avg()函数计算每组的birth_year平均值。将计算结果赋给birth_year_avg字段。

• 按组键字段以升序对文档进行排序。

• 根据组键字段的值创建profession字段，包含birth_year_avg字段并省略_id字段。

单击VIEW OUTPUT按钮，查看运行代码返回的数据：

$pipeline = User::aggregate()
    ->addFields(
        birth_year: Expression::year(
            Expression::dateFieldPath('birthday'),
        ),
    )
    ->group(
        _id: Expression::fieldPath('occupation'),
        birth_year_avg: Accumulator::avg(Expression::numberFieldPath('birth_year')),
    )
    ->sort(_id: Sort::Asc)
    ->project(profession: Expression::fieldPath('_id'), birth_year_avg: 1, _id: 0);