聚合（数据库命令）

aggregate

字符串

充当聚合管道的输入的集合或视图的名称。使用 1 执行与集合无关的命令。

pipeline

阵列

聚合管道阶段数组，作为聚合管道的一部分处理和转换文档流。

explain

布尔

可选。指定返回关于管道处理的信息。

不适用于多文档事务。

allowDiskUse

布尔

可选。

使用此选项可以覆盖特定查询的 allowDiskUseByDefault。您可以使用此选项执行以下任一操作：

• 禁止在默认允许使用磁盘的系统上使用磁盘。

• 支持在默认情况下禁止使用磁盘的系统上使用磁盘。

从 MongoDB 6.0 开始，如果 allowDiskUseByDefault 设置为 true，并且服务器需要超过 100 MB 的内存用于管道执行阶段，那么 MongoDB 会自动将临时文件写入磁盘，除非查询指定了 { allowDiskUse: false }。

有关详细信息，请参阅allowDiskUseByDefault。

如果聚合阶段因为内存限制而写入临时文件，则分析器日志消息和诊断日志消息包含一个 usedDisk 指示器。

allowPartialResults

布尔

可选。对于通过 mongos 针对分片集合运行的聚合，当一个或多个查询的分片不可用时，该命令可以返回部分结果，而不是错误。后续 getMore 命令也可以返回部分结果。默认为 false，如果查询的分片不可用，则返回错误。

Set allowPartialResults on the initial aggregate command only. You cannot set it on getMore, but each getMore inherits the setting from the cursor.

Since a shard can become unavailable at any point, partial results can appear in the initial aggregate response, in a later getMore response, or both. When a batch omits results from unavailable shards, that batch's response includes a partialResultsReturned: true field. When all queried shards are available for a batch, the response omits partialResultsReturned. partialResultsReturned can contain only documents from available shards. Do not assume the result set is complete when partialResultsReturned is true.

如果管道满足以下条件，该命令将返回 InvalidOptions 错误：

• 以写入阶段结束，例如 $out 或 $merge。

• 是一个 变更流 聚合。

• 包含一个 Atlas Search 阶段，例如 $search、$vectorSearch、$rankFusion 或 $scoreFusion。

cursor

文档

指定包含控制游标对象创建选项的文档。

You must use the aggregate command with the cursor option unless the command includes the explain option.

• 要指示具有默认批次大小的游标，请指定 cursor: {}。

• 要指示具有非默认批次大小的游标，请使用 cursor: { batchSize: <num> }。

maxTimeMS

non-negative integer

可选。

指定时间限制（以毫秒为单位）。如果您未指定 maxTimeMS 值，操作将不会超时。如果值为 0 ，则显式指定默认无限制行为。

MongoDB 使用与 db.killOp() 相同的机制终止超过分配的时间限制的操作。MongoDB 仅在指定的中断点之一中终止操作。

bypassDocumentValidation

布尔

可选。仅当您指定 $out 或 $merge 聚合阶段时使用。

启用 aggregate 可在此操作过程中绕过模式验证。 这使您能够插入不符合验证要求的文档。

readConcern

文档

可选。指定读关注。

readConcern 选项的语法如下：readConcern: { level: <value> }

可能的读关注级别是：

• "local"这是针对主节点和从节点的读操作的默认读关注级别。

• "available"。可用于对主节点和从节点执行读取操作。对于主节点和非分片从节点，"available" 行为与 "local" 相同。查询会返回实例的最新数据。

• "majority" 。适用于使用 WiredTiger 存储引擎的副本集。

• "linearizable"。仅适用于 primary 的读取操作。

• "snapshot"。可用于多文档事务以及多文档事务之外的某些读取操作。

有关读关注级别的更多信息，请参阅读关注级别。

$out 阶段不能与读关注 "linearizable" 一起使用。如果为 db.collection.aggregate() 指定 "linearizable" 读关注，则不能将 $out 阶段包括在管道中。

$merge 阶段不能与读关注 "linearizable" 一起使用。换言之，如果您为 db.collection.aggregate() 指定 "linearizable" 读关注，则不能将 $merge 阶段包括在管道中。

collation

文档

可选。

可选。指定用于操作的排序规则。

排序规则允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号规则。

排序规则选项的语法如下：

collation: {
    locale: <string>,
    caseLevel: <boolean>,
    caseFirst: <string>,
    strength: <int>,
    numericOrdering: <boolean>,
    alternate: <string>,
    maxVariable: <string>,
    backwards: <boolean>
 }

指定排序规则时，locale 字段为必填字段；所有其他排序规则字段均为可选字段。有关字段的说明，请参阅排序规则文档。

如果未指定排序规则，但集合具有默认排序规则（请参阅 db.createCollection()），则操作将使用为集合指定的排序规则。

如果没有为收集或操作指定排序规则，MongoDB 将使用先前版本中使用的简单二进制比较来进行字符串比较。

您不能为一个操作指定多个排序规则。例如，您不能为每个字段指定不同的排序规则，或者如果执行带排序的查找，则不能使用一种排序规则进行查找而另一种排序规则进行排序。

hint

字符串或文档

可选.用于该聚合的索引。该索引位于运行聚合的初始集合或视图上。

通过索引名称或索引规范文档来指定索引。

hint 不适用于 $lookup 和 $graphLookup 阶段。

comment

any

可选。用户提供的待附加到该命令的注释。设置后，该注释将与该命令的记录一起出现在以下位置：

• mongod 日志消息，位于 attr.command.cursor.comment 字段中。

• command.comment 字段中的数据库分析器输出。

• currentOp 输出，在 command.comment 字段。

注释可以是任何有效的 BSON 类型（字符串、整型、对象、数组等）。

在 aggregate 命令上设置的任何注释都将由在 aggregate 游标上运行的任何后续 getMore 命令继承。

writeConcern

文档

可选。一个表达写关注的文档，该写关注会与 $out 或 $merge 阶段一起配合使用。

在 $out 或 $merge 阶段省略使用默认写关注。

let

文档

可选。

指定包含变量列表的文档。这样可以将变量与查询文本分开，从而提高命令的可读性。

文档语法为：

{
  <variable_name_1>: <expression_1>,
  ...,
  <variable_name_n>: <expression_n>
}

变量设置为表达式返回的值，并且之后不能再进行更改。

要访问命令中的变量值，请使用双美元符号前缀 ($$) 以及 $$<variable_name> 形式的变量名称。例如：$$targetTotal。

要使用变量筛选管道 $match 阶段的结果，必须在 $expr 运算符中访问该变量。

For a complete example using let and variables, see Use Variables in let.

querySettings

文档

可选。仅应用于此命令执行的查询设置。querySettings 文档接受以下字段：

• indexHints

• queryFramework

• reject

• comment

• queryKnobs

• maxTimeMS

有关这些字段的说明，请参阅 命令字段。

MongoDB 不会在集群上存储这些设置，这些设置也不应用于具有相同 查询结构 的其他查询。要为查询结构设置持久有效的查询设置，请使用 setQuerySettings。

MongoDB 会将您在命令中传递的设置与集群上为同一查询结构存储的任何查询设置相结合。如果两个设置指定了同一个字段，则以存储的集群设置为准。