find（数据库命令）

find

字符串

要查询的集合或视图的名称。

filter

文档

可选。查询谓词。如未指定，则集合中的所有文档都将与谓词匹配。

sort

文档

可选。结果的排序规范。

projection

文档

可选。用于确定要在返回的文档中包含哪些字段的投影规范。

视图上的 find() 操作不支持以下 find 命令投影操作符：

• $

• $elemMatch

• $slice

• $meta

hint

字符串或文档

可选。索引规范。以字符串形式指定索引名称或索引键模式。如果指定，查询系统将只考虑使用提示索引的计划。

除以下例外情况外，如果命令包含 min 和/或 max 字段，则必须使用 hint；如果 filter 是 _id 字段 { _id: <value> } 的相等条件，则在使用 min 和/或 max 时，hint 不是必需的。

skip

正整数

可选。要跳过的文档数。默认值为 0。

limit

Non-negative integer

可选。要返回的最大文档数。如果未指定，则默认为无限制。限制为 0 相当于不设限制。

batchSize

non-negative integer

可选。查询结果中每批次可返回的最大文档数量。默认情况下，find 命令的初始 batchSize 为 101 个文档或 16 个兆字节（MiB）中的较小值。后续批次的最大大小为 16 MiB。此选项可以强制执行比 16 MiB 更小的限制，但不能强制执行更大的限制。设置后，batchSize 是 batchSize 个文档或 16 MiB 文档中较小的一个。

batchSize 为 0 是指将建立游标，但第一批不会返回任何文档。

与之前的传输协议版本不同，1 命令的 findbatchSize 为 不会关闭游标。

singleBatch

布尔

可选。确定是否在第一次批处理后关闭游标。默认值为 false。

comment

any

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

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

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

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

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

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

maxTimeMS

non-negative integer

可选。

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

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

指定 linearizable read concern 时，如果大多数数据承载节点不可用，则始终使用 maxTimeMS。maxTimeMS 确保操作不会无限期受阻，而且在无法满足读关注时返回错误。

readConcern

文档

可选。指定读关注。

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

可能的读关注级别是：

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

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

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

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

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

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

getMore 命令使用原始 find 命令中指定的 readConcern 级别。

max

文档

可选。特定索引的独占上限。请参阅 cursor.max() 了解详细信息。

要使用 max 字段，该命令还必须使用 hint ，除非指定的 filter 是 _id 字段 { _id: <value> }上的相等条件。

min

文档

可选。特定索引的包含下限。请参阅 cursor.min() 了解详细信息。

要使用 min 字段，该命令还必须使用 hint ，除非指定的 filter 是 _id 字段 { _id: <value> }上的相等条件。

returnKey

布尔

可选。如果为 true，则仅返回结果文档中的索引键。默认值为 false。如果 returnKey 为 true 且find 命令不使用索引，则返回的文档将为空。

showRecordId

布尔

可选。确定是否返回每个文档的记录标识符。如果为 true，则将字段 $recordId 添加到返回文档。

tailable

布尔

可选。返回固定大小集合的可追加游标。

awaitData

布尔

可选。与 tailablegetMore 选项结合使用，可在数据末尾暂时区块游标上的 命令，而不是不返回数据。超时一段时间后，find 将正常返回。

noCursorTimeout

布尔

可选。阻止服务器在一段不活动时间（30 分钟）后将非会话空闲游标设置为超时。对于属于会话的游标，处理会被忽略。有关更多信息，请参阅会话空闲超时。

allowPartialResults

布尔

可选。对于针对分片集合的查询，如果一个或多个查询的分片不可用，则允许该命令（或后续 getMore 命令）返回部分结果，而非错误。

如果find （或后续的getMore 命令）由于查询的分片不可用而返回部分结果，则 find 输出将包含partialResultsReturned 指示符字段。如果查询的分片可用于初始find 命令，但一个或多个分片不可用于后续的 命令，则只有在分片不可用时运行的getMore getMorepartialResultsReturned命令才会在其输出中包含 。

collation

文档

可选。

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

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

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

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

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

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

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

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

allowDiskUse

布尔

可选。

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

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

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

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

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

allowDiskUse 如果MongoDB可以使用索引满足指定的排序，或者内存中排序需要的内存少于 MB，则 MongoDB100 不会产生任何影响。

有关 allowDiskUse 的更完整文档，请参见 cursor.allowDiskUse()。

如需进一步了解大型内存排序的内存限制，请参阅排序和索引使用。

let

文档

可选。

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

文档语法为：

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

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

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

要使用变量筛选结果，您必须在 $expr 操作符中访问该变量。

有关使用let 和变量的完整示例，请参阅在 let中使用变量。