On this page本页内容
db.collection.
aggregate
(pipeline, options)¶mongo
Shell Method方法
This page documents the 此页面记录了mongo
shell method, and does not refer to the MongoDB Node.js driver (or any other driver) method.mongo
Shell方法,未提及MongoDB Node.js驱动程序(或任何其他驱动程序)方法。For corresponding MongoDB driver API, refer to your specific MongoDB driver documentation instead.有关相应的MongoDB驱动程序API,请参阅特定的MongoDB驱动程序文档。
Calculates aggregate values for the data in a collection or a view.计算集合或视图中数据的聚合值。
pipeline |
array |
|
options |
document | aggregate() passes to the aggregate command.aggregate() 传递给aggregate 命令的其他选项。pipeline as an array.pipeline 指定为数组时可用。 |
The options
document can contain the following fields and values:options
文档可以包含以下字段和值:
explain |
boolean |
|
allowDiskUse |
boolean |
|
cursor |
document | cursor field is a document with the field batchSize .cursor 字段的值是具有batchSize 字段的文档。 |
maxTimeMS |
| |
bypassDocumentValidation |
boolean |
|
readConcern |
document |
|
collation | document | Optional.
Collation The collation option
|
hint |
Note
| |
comment |
string |
|
writeConcern |
document |
|
explain option, the document that provides details on the processing of the aggregation operation. explain 选项,则指向提供聚合操作处理细节的文档。
|
If an error occurs, the 如果发生错误,aggregate()
helper throws an exception.aggregate()
助手将抛出异常。
In the 在mongo
shell, if the cursor returned from the db.collection.aggregate()
is not assigned to a variable using the var
keyword, then the mongo
shell automatically iterates the cursor up to 20 times. mongo
shell中,如果游标从没有使用var
关键字分配给一个变量的db.collection.aggregate()
返回,则mongo
shell会自动将游标迭代多达20次。See Iterate a Cursor in the mongo Shell for handling cursors in the 有关在mongo
shell.mongo
Shell中处理游标的信息,请参阅在mongo Shell中迭代游标。
Cursors returned from aggregation only supports cursor methods that operate on evaluated cursors (i.e. cursors whose first batch has been retrieved), such as the following methods:从聚合返回的游标仅支持对已评估游标(即已检索第一批的游标)进行操作的游标方法,例如以下方法:
See also参阅
For more information, see Aggregation Pipeline, Aggregation Reference, Aggregation Pipeline Limits, and 有关更多信息,请参阅聚合管道、聚合参考、聚合管道限制和aggregate
.aggregate
。
New in version 4.0.版本4.0中的新功能。
For cursors created inside a session, you cannot call 对于在会话内创建的游标,不能在会话外调用getMore
outside the session.getMore
。
Similarly, for cursors created outside of a session, you cannot call 同样,对于在会话外部创建的游标,不能在会话内部调用getMore
inside a session.getMore
。
Starting in MongoDB 3.6, MongoDB drivers and the 从MongoDB 3.6开始,MongoDB驱动程序和mongo
shell associate all operations with a server session, with the exception of unacknowledged write operations. mongo
shell将所有操作与服务器会话相关联,但未确认的写入操作除外。For operations not explicitly associated with a session (i.e. using 对于与会话没有显式关联的操作(即使用Mongo.startSession()
), MongoDB drivers and the mongo
shell creates an implicit session and associates it with the operation.Mongo.startSession()
),MongoDB驱动程序和mongo
shell会创建一个隐式会话,并将其与操作关联。
If a session is idle for longer than 30 minutes, the MongoDB server marks that session as expired and may close it at any time. 如果会话空闲时间超过30分钟,MongoDB服务器会将该会话标记为已过期,并可随时将其关闭。When the MongoDB server closes the session, it also kills any in-progress operations and open cursors associated with the session. 当MongoDB服务器关闭会话时,它还会终止任何正在进行的操作以及与会话相关的打开游标。This includes cursors configured with 这包括配置了noCursorTimeout
or a maxTimeMS
greater than 30 minutes.noCursorTimeout
或maxTimeMS
(大于30分钟)的游标。
For operations that return a cursor, if the cursor may be idle for longer than 30 minutes, issue the operation within an explicit session using 对于返回游标的操作,如果游标空闲时间可能超过30分钟,请使用Session.startSession()
and periodically refresh the session using the refreshSessions
command. Session.startSession()
在显式会话中发出该操作,并使用refreshSessions命令定期刷新会话。See 有关更多信息,请参阅Session Idle Timeout
for more information.Session Idle Timeout
。
可以在多文档事务中使用db.collection.aggregate()
can be used inside multi-document transactions.db.collection.aggregate()
。
However, the following stages are not allowed within transactions:但是,事务中不允许以下阶段:
You also cannot specify the 也不能指定explain
option.explain
选项。
getMore
inside the transaction.getMore
。getMore
outside the transaction.getMore
。Important重要的
In most cases, multi-document transaction incurs a greater performance cost over single document writes, and the availability of multi-document transactions should not be a replacement for effective schema design. 在大多数情况下,与单文档写入相比,多文档事务会带来更大的性能成本,而多文档事务的可用性不应取代有效的模式设计。For many scenarios, the denormalized data model (embedded documents and arrays) will continue to be optimal for your data and use cases. 对于许多场景,非规范化数据模型(嵌入式文档和数组)将继续适合您的数据和用例。That is, for many scenarios, modeling your data appropriately will minimize the need for multi-document transactions.也就是说,对于许多场景,适当地建模数据将最大限度地减少对多文档事务的需求。
For additional transactions usage considerations (such as runtime limit and oplog size limit), see also Production Considerations.有关其他事务使用注意事项(如运行时限制和oplog大小限制),请参阅生产注意事项。
For 对于不包括db.collection.aggregate()
operation that do not include the $out
or $merge
stages:$out
阶段或$merge
阶段的db.collection.aggregate()
操作:
Starting in MongoDB 4.2, if the client that issued the 从MongoDB 4.2开始,如果发布在操作完成之前断开连接的db.collection.aggregate()
disconnects before the operation completes, MongoDB marks the db.collection.aggregate()
for termination (i.e. killOp
on the operation).db.collection.aggregate()
的客户端,MongoDB会标记db.collection.aggregate()
用于终止(即killOp
操作)。
The following examples use the collection 以下示例使用包含以下文档的集合orders
that contains the following documents:orders
:
The following aggregation operation selects documents with status equal to 以下聚合操作选择状态等于"A"
, groups the matching documents by the cust_id
field and calculates the total
for each cust_id
field from the sum of the amount
field, and sorts the results by the total
field in descending order:"A"
的文档,按cust_id
字段对匹配的文档进行分组,并根据amount
字段的总和计算每个cust_id
字段的合计(total
),并按total
字段降序排列结果:
The operation returns a cursor with the following documents:该操作将返回包含以下文档的游标:
The mongo
shell iterates the returned cursor automatically to print the results. mongo
shell会自动迭代返回的游标以打印结果。See Iterate a Cursor in the mongo Shell for handling cursors manually in the 有关在mongo
shell.mongo
Shell中手动处理游标的信息,请参阅在mongo Shell中迭代游标。
The following example uses 下面的示例使用db.collection.explain()
to view detailed information regarding the execution plan of the aggregation pipeline.db.collection.explain()
查看有关聚合管道执行计划的详细信息。
The operation returns a document that details the processing of the aggregation pipeline. 该操作返回一个文档,详细说明聚合管道的处理过程。For example, the document may show, among other details, which index, if any, the operation used. 例如,除其他细节外,文档可能会显示所使用的操作的索引(如果有的话)。[1] If the 如果orders
collection is a sharded collection, the document would also show the division of labor between the shards and the merge operation, and for targeted queries, the targeted shards.orders
集合是分片集合,文档还将显示分片和合并操作之间的分工,对于目标查询,显示目标分片。
Note
The intended readers of the explain
output document are humans, and not machines, and the output format is subject to change between releases.explain
输出文档的目标读者是人类,而不是机器,输出格式可能会在不同版本之间发生变化。
You can view more verbose explain output by passing the 通过将executionStats
or allPlansExecution
explain modes to the db.collection.explain()
method.executionStats
或allPlansExecution
解释模式传递给数db.collection.explain()
方法,可以查看更详细的解释输出。
[1] |
Aggregation pipeline stages have maximum memory use limit. 聚合管道阶段有最大内存使用限制。To handle large datasets, set 要处理大型数据集,请将allowDiskUse
option to true
to enable writing data to temporary files, as in the following example:allowDiskUse
选项设置为true
,以允许将数据写入临时文件,如下例所示:
Starting in MongoDB 4.2, the profiler log messages and diagnostic log messages includes a 从MongoDB 4.2开始,如果任何聚合阶段由于内存限制将数据写入临时文件,探查器日志消息和诊断日志消息将包括usedDisk
indicator if any aggregation stage wrote data to temporary files due to memory restrictions.usedDisk
指示符。
To specify an initial batch size for the cursor, use the following syntax for the 要为游标指定初始批量大小,请对cursor
option:cursor
选项使用以下语法:
For example, the following aggregation operation specifies the initial batch size of 例如,以下聚合操作将游标的初始批量大小指定为0
for the cursor:0
:
A batchSize
of 0
means an empty first batch and is useful for quickly returning a cursor or failure message without doing significant server-side work. batchSize
为0
表示第一批为空,用于快速返回游标或失败消息,而无需执行大量服务器端工作。Specify subsequent batch sizes to OP_GET_MORE operations as with other MongoDB cursors.与其他MongoDB游标一样,对OP_GET_MORE操作指定后续批处理大小。
The mongo
shell iterates the returned cursor automatically to print the results. mongo
shell会自动迭代返回的游标以打印结果。See Iterate a Cursor in the mongo Shell for handling cursors manually in the 有关在mongo Shell中手动处理游标的信息,请参阅在mongo Shell中迭代游标。mongo
shell.
New in version 3.4.版本3.4中的新功能。
Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.排序规则允许用户为字符串比较指定特定于语言的规则,例如字母大小写和重音符号的规则。
A collection myColl
has the following documents:myColl
集合包含以下文档:
The following aggregation operation includes the collation option:以下聚合操作包括排序规则选项:
Note
If performing an aggregation that involves multiple views, such as with 如果执行涉及多个视图的聚合,例如使用$lookup
or $graphLookup
, the views must have the same collation.$lookup
或$graphLookup
,则这些视图必须具有相同的排序规则。
For descriptions on the collation fields, see Collation Document.有关排序规则字段的说明,请参阅排序规则文档。
New in version 3.6.版本3.6中的新功能。
Create a collection 使用以下文档创建集合foodColl
with the following documents:foodColl
:
Create the following indexes:创建以下索引:
The following aggregation operation includes the 以下聚合操作包括hint
option to force the usage of the specified index:hint
选项,用于强制使用指定的索引:
readConcern
¶Use the 使用readConcern
option to specify the read concern for the operation.readConcern
选项指定操作的读取关注点。
You cannot use the 不能将$out
or the $merge
stage in conjunction with read concern "linearizable"
. $out
阶段或$merge
阶段与读取关注点"linearizable"
结合使用。That is, if you specify 也就是说,如果指定"linearizable"
read concern for db.collection.aggregate()
, you cannot include either stages in the pipeline.db.collection.aggregate()
的"linearizable"
读取关注点,不能在管道中包含任何阶段。
The following operation on a replica set specifies a Read Concern of 以下对副本集的操作指定"majority"
to read the most recent copy of the data confirmed as having been written to a majority of the nodes."majority"
(多数)的读取关注点,以读取确认已写入多数Node的数据的最新副本。
Note
"majority"
, replica sets must use WiredTiger storage engine."majority"
的读关注级别,副本集必须使用WiredTiger存储引擎。
You can disable read concern 对于具有三成员主从仲裁器(PSA)体系结构的部署,可以禁用读关注点"majority"
for a deployment with a three-member primary-secondary-arbiter (PSA) architecture; however, this has implications for change streams (in MongoDB 4.0 and earlier only) and transactions on sharded clusters. "majority"
;然而,这对变更流(仅在MongoDB 4.0及更早版本中)和分片集群上的事务有影响。For more information, see Disable Read Concern Majority.有关更多信息,请参阅禁用读取关注多数。
"majority"
read concern and "majority"
write concern against the primary of the replica set."majority"
读取关注点和"majority"
写入关注点。"majority"
for an aggregation that includes an $out
stage.$out
阶段的聚合指定读关注级别"majority"
。
In MongoDB 4.0 and earlier, you cannot include the 在MongoDB 4.0及更早版本中,不能将$out
stage to use "majority"
read concern for the aggregation.$out
阶段包含在聚合中使用"majority"
读取关注点。
A collection named 名为movies
contains documents formatted as such:movies
的集合包含以下格式的文档:
The following aggregation operation finds movies created in 1995 and includes the 下面的聚合操作将查找1995年创建的电影,并包括comment
option to provide tracking information in the logs
, the db.system.profile
collection, and db.currentOp
.comment
选项,以在logs
、db.system.profile
集合和db.currentOp
中提供跟踪信息。
On a system with profiling enabled, you can then query the 在启用了分析功能的系统上,可以查询system.profile
collection to see all recent similar aggregations, as shown below:system.profile
集合以查看所有最近的类似聚合,如下所示:
This will return a set of profiler results in the following format:这将以以下格式返回一组探查器结果:
An application can encode any arbitrary information in the comment in order to more easily trace or identify specific operations through the system. 应用程序可以对注释中的任意信息进行编码,以便通过系统更容易地跟踪或识别特定操作。For instance, an application might attach a string comment incorporating its process ID, thread ID, client hostname, and the user who issued the command.例如,应用程序可能会附加一个字符串注释,其中包含其进程ID、线程ID、客户端主机名和发出命令的用户。