聚合构建器

概述

在本指南中，您可以学习如何使用 聚合类，该类提供了静态工厂方法，用于在 MongoDB Java 驱动程序中构建聚合管道阶段。

要了解有关聚合的更多信息，请参阅我们的聚合指南。要了解如何使用可发现且类型安全的 Java 方法创建表达式操作以在聚合中使用，请参阅聚合表达式操作。

import static com.mongodb.client.model.Aggregates.*;
import static com.mongodb.client.model.Filters.*;
import static com.mongodb.client.model.Projections.*;
import static com.mongodb.client.model.Sorts.*;
import static com.mongodb.client.model.Accumulators.*;
import static com.mongodb.client.model.search.SearchPath.fieldPath;
import static com.mongodb.client.model.search.VectorSearchOptions.vectorSearchOptions;
import static java.util.Arrays.asList;

使用这些方法构建管道阶段，并在聚合中以列表形式予以指定：

Bson matchStage = match(eq("some_field", "some_criteria"));
Bson sortByCountStage = sortByCount("some_field");
collection.aggregate(asList(matchStage, sortByCountStage)).forEach(doc -> System.out.println(doc));

匹配

使用 match() 方法创建 $match 管道阶段，根据指定的查询过滤器匹配传入的文档，过滤掉不匹配的文档。

以下示例创建一个管道阶段，用于匹配 title 字段等于“The Shawshank Redemption”的所有文档：

match(eq("title", "The Shawshank Redemption"));

项目

使用project()方法创建用于投影指定文档字段的$project管道阶段。 聚合中的字段投影遵循与查询中的字段投影相同的规则。

以下示例创建一个管道阶段，其中不包括 _id 字段，但包括 title 和 plot 字段：

project(fields(include("title", "plot"), excludeId()));

project(fields(computed("rating", "$rated"), excludeId()));

文档 (Document）

使用 documents() 方法创建 $documents 管道阶段，从输入值返回字面文档。

以下示例创建一个管道阶段，用于创建带有 title 字段的示例文档：

documents(asList(
        new Document("title", "The Shawshank Redemption"),
        new Document("title", "Back to the Future"),
        new Document("title", "Jurassic Park")));

抽检 (Sample)

使用 sample() 方法创建 $sample 管道阶段，从输入中随机选择文档。

以下示例创建一个管道阶段，用于随机选择 5 个文档：

sample(5);

排序

使用 sort() 方法创建 $sort 管道阶段，根据指定条件进行排序。

以下示例创建了管道阶段，根据 year 字段的值以降序排序，然后根据 title 字段的值以升序排序：

sort(orderBy(descending("year"), ascending("title")));

跳过

使用 skip() 方法创建一个 $skip 管道阶段，以在将文档传递到下一阶段之前跳过指定数量的文档。

以下示例创建了一个跳过前 5 个文档的管道阶段：

skip(5);

极限

使用 $limit 管道阶段来限制传递到下一阶段的文档数量。

以下示例将创建一个管道阶段，从而将文档数量限制为 10 个：

limit(10);

Lookup

使用 lookup() 方法创建 $lookup 管道阶段，在两个集合之间执行连接和非相关子查询。

lookup("comments", "_id", "movie_id", "joined_comments");

List<Variable<String>> variables = asList(new Variable<>("order_item", "$item"),
        new Variable<>("order_qty", "$ordered"));
List<Bson> pipeline = asList(
        match(expr(new Document("$and",
                asList(new Document("$eq", asList("$$order_item", "$stock_item")),
                        new Document("$gte", asList("$instock", "$$order_qty")))))),
        project(fields(exclude("stock_item"), excludeId())));
Bson innerJoinLookup = lookup("warehouses", variables, pipeline, "stockdata");

GROUP

使用 group() 方法创建 $group 管道阶段，根据指定表达式对文档分组，并为每个不同分组输出一个文档。

以下示例创建了一个管道阶段，该阶段按照 customerId 字段的值对文档进行分组。每个组将 quantity 字段值的总和和平均值累积到 totalQuantity 和 averageQuantity 字段中。

group("$customerId", sum("totalQuantity", "$quantity"), avg("averageQuantity", "$quantity"));

从MongoDB Server手册中有关累加器的部分，了解有关累加器操作符的更多信息。

Pick-n 累加器

pick-n 累加器是聚合累加操作符，在特定排序的情况下返回顶部和底部元素。使用下列生成器之一创建聚合累加操作符：

• minN()

• maxN()

• firstN()

• lastN()

• top()

• topN()

• bottom()

• bottomN()

从MongoDB Server手册中有关累加器的部分，了解可以将累加器操作符与哪些聚合管道阶段一起使用。

group(
        "$year",
        minN(
                "lowest_three_ratings",
                new BsonString("$imdb.rating"),
                3
                ));

group(
        "$year",
        maxN(
                "highest_two_ratings",
                new BsonString("$imdb.rating"),
                2
                ));

group(
        "$year",
        firstN(
                "first_four_movies",
                new BsonString("$title"),
                4
                ));

group(
        "$year",
        lastN(
                "last_three_movies",
                new BsonString("$title"),
                3
                ));

group(
        "$year", 
        top(
                "top_rated_movie",
                descending("imdb.rating"),
                asList(new BsonString("$title"), new BsonString("$imdb.rating"))
                ));

group(
        "$year", 
        topN(
                "longest_three_movies",
                descending("runtime"),
                asList(new BsonString("$title"), new BsonString("$runtime")),
                3
                ));

group(
        "$year", 
        bottom(
                "shortest_movies",
                descending("runtime"),
                asList(new BsonString("$title"), new BsonString("$runtime"))
                ));

group(
        "$year", 
        bottomN(
                "lowest_rated_two_movies",
                descending("imdb.rating"),
                asList(new BsonString("$title"), new BsonString("$imdb.rating")),
                2
                ));

放松

使用 unwind() 方法创建 $unwind 管道阶段，从输入文档解构数组字段，为每个数组元素创建输出文档。

以下示例为 sizes 数组中的每个元素创建了文档：

unwind("$sizes");

要保留数组字段缺失或数组字段的 null 值为空的文档，请执行以下操作：

unwind("$sizes", new UnwindOptions().preserveNullAndEmptyArrays(true));

若要包含数组索引，则请在此示例中，在名为 "position" 的字段中：

unwind("$sizes", new UnwindOptions().includeArrayIndex("position"));

Out

使用 out() 方法创建 $out 管道阶段，将所有文档写入同一数据库中的指定集合。

以下示例将管道结果写入 authors 集合：

out("authors");

合并(merge)

使用 merge() 方法创建 $merge 管道阶段，将所有文档合并到指定的集合中。

以下示例使用默认选项将管道合并到 authors 集合中：

merge("authors");

以下示例通过一些选项将管道合并到 reporting 数据库中的 customers 集合，这些选项指定，如果 date 和 customerId 都匹配，则替换文档，否则插入文档：

merge(new MongoNamespace("reporting", "customers"),
        new MergeOptions().uniqueIdentifier(asList("date", "customerId"))
                .whenMatched(MergeOptions.WhenMatched.REPLACE)
                .whenNotMatched(MergeOptions.WhenNotMatched.INSERT));

GraphLookup

使用 graphLookup() 方法创建 $graphLookup 管道阶段，对指定集合执行递归搜索，以将一个文档中的指定字段与另一个文档的指定字段进行匹配。

以下示例计算 contacts 集合中用户的社交网络图，以递归方式将 friends 字段的值与 name 字段进行匹配：

graphLookup("contacts", "$friends", "friends", "name", "socialNetwork");

使用 GraphLookupOptions，如果需要，您可以指定要递归的深度以及深度字段的名称。在本例中，$graphLookup 最多会递归两次，并为每个文档创建名为 degrees 的字段，其中包含递归深度信息。

graphLookup("contacts", "$friends", "friends", "name", "socialNetwork",
        new GraphLookupOptions().maxDepth(2).depthField("degrees"));

使用 GraphLookupOptions，您可以指定筛选器，文档必须与该筛选器匹配，MongoDB 才能将其包含在搜索中。在此示例中，只有 hobbies 字段包含“golf”的链接才会被包括在内。

graphLookup("contacts", "$friends", "friends", "name", "socialNetwork",
        new GraphLookupOptions().maxDepth(1).restrictSearchWithMatch(eq("hobbies", "golf")));

SortByCount

使用 sortByCount() 方法创建 $sortByCount 管道阶段，根据给定表达式对文档分组，然后按计数降序对这些分组排序。

[
    { "$group": { "_id": <expression to group on>, "count": { "$sum": 1 } } },
    { "$sort": { "count": -1 } }
]

下面的示例按照字段 x 的截断值对文档进行分组，并计算每个不同值的计数：

sortByCount(new Document("$floor", "$x"));

ReplaceRoot

使用 replaceRoot() 方法创建 $replaceRoot 管道阶段，用指定文档替换每个输入文档。

以下示例将每个输入文档替换为 spanish_translation 字段中的嵌套文档：

replaceRoot("$spanish_translation");

AddFields

使用 addFields() 方法创建 $addFields 管道阶段，为文档添加新字段。

以下示例会将两个新字段 a 和 b 添加到输入文档：

addFields(new Field("a", 1), new Field("b", 2));

数数

使用count()方法创建$count管道阶段，用于计算进入该阶段的文档数量，并将该值分配给指定的字段名称。 如果未指定字段， count()将默认字段名称为“计数”。

{ "$group":{ "_id": 0, "count": { "$sum" : 1 } } }

以下示例创建了管道阶段，在名为“总计”的字段中输出传入文档的计数：

count("total");

桶模式

使用 bucket() 方法创建 $bucket 管道阶段，该阶段可自动围绕预定义的边界值对数据进行分组。

以下示例创建了一个管道阶段，该阶段根据传入文档的 screenSize 字段的值（包括下边界但不包括上边界）对传入文档进行分组。

bucket("$screenSize", asList(0, 24, 32, 50, 70, 200));

使用 BucketOptions 类为指定边界之外的值指定默认存储桶，并指定其他累加器。

以下示例创建了一个管道阶段，根据传入文档的 screenSize 字段的值对传入文档进行分组，计算每个存储桶中的文档数量，将 screenSize 的值推送到名为 matches 的字段，并将任何大于“70”的屏幕尺寸捕获到一个名为“monster”的存储桶中，用于超大屏幕尺寸：

bucket("$screenSize", asList(0, 24, 32, 50, 70),
        new BucketOptions().defaultBucket("monster").output(sum("count", 1), push("matches", "$screenSize")));

BucketAuto

使用 bucketAuto() 方法创建 $bucketAuto 管道阶段，自动确定每个存储桶的边界，试图将文档平均分配到指定数量的存储桶中。

以下示例将创建一个管道阶段，而该阶段会尝试使用文档的 price 字段值来创建文档并将其均匀分发到 10 个存储桶中：

bucketAuto("$price", 10);

使用 BucketAutoOptions 类指定基于数字的首选方案来设置边界值，然后指定额外的累加器。

以下示例创建了一个管道阶段，将尝试使用文档的 price 字段的值创建文档并将其均匀分布到 10 个存储桶中，并将存储桶边界设置为 2 的幂（2、4、8、16...）。它还计算每个存储桶中的文档数量，并在名为 avgPrice 的新字段中计算它们的 price 平均值：

bucketAuto("$price", 10, new BucketAutoOptions().granularity(BucketGranularity.POWERSOF2)
        .output(sum("count", 1), avg("avgPrice", "$price")));

多面

使用 facet() 方法创建 $facet 管道阶段，允许定义并行管道。

以下示例创建了一个管道阶段，用于执行两个并行聚合：

• 第一个聚合将传入的文档根据其 attributes.screen_size 字段分成 5 组。

• 第二个聚合对所有制造商进行计数并返回其计数，仅限于前 5 个。

facet(new Facet("Screen Sizes",
        bucketAuto("$attributes.screen_size", 5, new BucketAutoOptions().output(sum("count", 1)))),
        new Facet("Manufacturer", sortByCount("$attributes.manufacturer"), limit(5)));

SetWindowFields

使用 setWindowFields() 方法创建 $setWindowFields 管道阶段，允许使用窗口操作符对集合中指定跨度的文档执行操作。

以下示例创建了一个管道阶段，用于利用 rainfall 和 temperature 字段更精细的测量值，计算每个地点过去一个月累计的降雨量和平均气温：

Window pastMonth = Windows.timeRange(-1, MongoTimeUnit.MONTH, Windows.Bound.CURRENT);
setWindowFields("$localityId", Sorts.ascending("measurementDateTime"),
        WindowOutputFields.sum("monthlyRainfall", "$rainfall", pastMonth),
        WindowOutputFields.avg("monthlyAvgTemp", "$temperature", pastMonth));

Densify

使用 densify() 方法创建 $densify 管道阶段，生成跨越指定时间间隔的文档序列。

考虑从Atlas 样本天气数据集中检索到的以下文档，其中包含类似position字段的测量值，测量间隔为一小时：

Document{{ _id=5553a..., position=Document{{type=Point, coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 08:00:00 EST 1984, ... }}
Document{{ _id=5553b..., position=Document{{type=Point, coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 09:00:00 EST 1984, ... }}

假设需要创建管道阶段，对这些文档执行以下操作：

• 每隔 15 分钟添加一个尚未存在 ts 值的文档。

• 按 position 字段对文档分组。

调用 densify() 聚合阶段构建器完成这些操作的过程如下：

densify(
        "ts", 
        DensifyRange.partitionRangeWithStep(15, MongoTimeUnit.MINUTE),
        DensifyOptions.densifyOptions().partitionByFields("position.coordinates"));

以下输出突出显示聚合阶段生成的文档，其中现有文档之间每 15 分钟包含 ts 值：

Document{{ _id=5553a..., position=Document{{type=Point, coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 08:00:00 EST 1984, ... }}
Document{{ position=Document{{coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 08:15:00 EST 1984 }}
Document{{ position=Document{{coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 08:30:00 EST 1984 }}
Document{{ position=Document{{coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 08:45:00 EST 1984 }}
Document{{ _id=5553b..., position=Document{{type=Point, coordinates=[-47.9, 47.6]}}, ts=Mon Mar 05 09:00:00 EST 1984, ... }}

请参阅使软件包 API 文档密集化，了解更多信息。

填

使用fill()方法创建填充null和缺失字段值的$fill管道阶段。

以下文档包含每小时的温度和气压测量值：

Document{{_id=6308a..., hour=1, temperature=23C, air_pressure=29.74}}
Document{{_id=6308b..., hour=2, temperature=23.5C}}
Document{{_id=6308c..., hour=3, temperature=null, air_pressure=29.76}}

假设您需要在文档中填充缺失的温度和气压数据点，如下所示：

• 使用线性插值填充小时“2”的 air_pressure 字段来计算值。

• 将缺失的 temperature 值设置为“23.6C”时间为“3”小时。

调用 fill() 聚合阶段构建器完成这些操作的过程如下：

fill(
        FillOptions.fillOptions().sortBy(ascending("hour")),
        FillOutputField.value("temperature", "23.6C"),
        FillOutputField.linear("air_pressure")
        );

下面的输出突出显示文档，其中包含由聚合阶段填充的字段：

Document{{_id=6308a..., hour=1, temperature=23C, air_pressure=29.74}}
Document{{_id=6308b..., hour=2, temperature=23.5C, air_pressure=29.75}}
Document{{_id=6308c..., hour=3, temperature=23.6C, air_pressure=29.76}}

请参阅填充软件包 API 文档，了解更多信息。

Atlas 全文搜索

使用 search() 方法来创建 $search 管道阶段，从而指定针对一个或多个字段的全文搜索。

以下示例创建了一个管道阶段，该阶段在 title 字段中搜索包含“Future”一词的文本：

Bson textSearch = Aggregates.search(
        SearchOperator.text(
                SearchPath.fieldPath("title"), "Future"));

通过Atlas Search 包API 文档了解有关构建器的更多信息。

Atlas Search 元数据

使用 searchMeta() 方法创建 $searchMeta 管道阶段，只返回 Atlas 全文搜索查询结果的元数据部分。

以下示例显示了 Atlas 搜索聚合阶段的 count 元数据：

Aggregates.searchMeta(
        SearchOperator.near(2010, 1, SearchPath.fieldPath("year")));

通过 searchMeta() API 文档了解有关此助手的更多信息。

Atlas Vector Search

使用 vectorSearch() 方法，创建用于指定语义搜索的 $vectorSearch 管道阶段。语义搜索是一种查找含义相似信息的搜索。

要使用此功能，您必须设置矢量Atlas Search索引并为矢量嵌入创建索引。 要了解如何在MongoDB Atlas中设置这些内容，请参阅如何为 Vector Atlas Search的向量嵌入创建索引。

以下示例展示了如何构建一个聚合管道，从而使用 vectorSearch() 和 project() 方法计算向量搜索分数：

List<Double> queryVector = (asList(-0.0072121937, -0.030757688, -0.012945653));
String indexName = "mflix_movies_embedding_index";
FieldSearchPath fieldSearchPath = fieldPath("plot_embedding");
int numCandidates = 2;
int limit = 1;
VectorSearchOptions options = vectorSearchOptions().filter(gte("year", 2016));
List<Bson> pipeline = asList(
        vectorSearch(
                fieldSearchPath,
                queryVector,
                indexName,
                numCandidates,
                limit,
                options),
        project(
                metaVectorSearchScore("vectorSearchScore")));

以下示例显示如何打印上述聚合管道结果的分数：

Document found = collection.aggregate(pipeline).first();
double score = found.getDouble("vectorSearchScore").doubleValue();
System.out.println("vectorSearch score: " + score);

通过 VectorSearch () API 文档了解有关此辅助程序的更多信息。