createIndexes（数据库命令）

createIndexes

字符串

要创建索引的集合。

indexes

阵列

指定要创建的索引。数组中的每个文档都指定一个单独的索引。

writeConcern

文档

可选。表达写关注的文档。省略以使用默认写关注。

commitQuorum

整数或字符串

可选。承载数据的副本集成员的最小数量（即提交法定节点数），包括主节点，必须在主节点将 indexes 标记为就绪之前报告索引构建成功。

当提交法定人数设置为默认 "votingMembers"时，您可以恢复一些 中断的索引构建。请参阅 setIndexCommitQuorum。

提交法定人数中的副本集节点必须将 members[n].buildIndexes 设置为 true。如果任何投票节点将 members[n].buildIndexes设置为 false，则无法使用默认 "votingMembers" 提交法定人数。配置所有节点以将 members[n].buildIndexes 设置为 true，或者选择不同的提交法定人数。

支持以下值：

• "votingMembers" - 所有承载数据的有投票权副本集成员（默认）。“投票”成员是 members[n].votes 大于 0 的任何副本集成员。

• "majority" - 数据承载投票副本集成员的简单多数制。

• <int> - 特定数量的承载数据的副本集节点。

• 0 - 禁用法定人数投票行为。成员同时开始索引构建，但在完成索引构建之前不投票或等待法定人数。如果您使用 0 的提交法定人数启动索引构建，则以后无法使用 setIndexCommitQuorum 修改提交法定人数。

• 副本集标记名称。

comment

any

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

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

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

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

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

key

文档

指定索引的字段。对于每个字段，指定一个键值对，其中键是要索引的字段的名称，值是索引方向或索引类型。如果指定方向，请指定 1 为升序，或 -1 为降序。

MongoDB 支持多种不同的索引类型，包括：

• text

• geospatial

• 哈希索引

有关更多信息，请参阅索引类型。

通配符索引支持用户对自定义字段或集合中的大量字段进行查询的工作负载：

• 您可以为特定字段及其子路径或文档中的所有字段创建通配符索引。

  有关详细信息，请参阅通配符索引。

name

字符串

唯一地标识索引的名称。

unique

布尔

可选。 创建唯一索引，以便集合不会接受索引键值与索引中现有值匹配的文档插入或更新。

指定 true 可创建唯一索引。默认值为 false。

该选项不适用于哈希索引。

partialFilterExpression

文档

可选。如果指定，索引只引用与过滤器表达式匹配的文档。有关更多信息，请参阅部分索引。

过滤器表达式可以包括：

• 等式表达式（即field: value 或使用 $eq 操作符）

• $exists: true 表达式(expression)

• $gt、$gte、$lt、$lte 表达式

• $type 表达式

• $and 运算符

• $or 运算符

• $in 运算符

• $geoWithin 运算符

• $geoIntersects 运算符

如果使用客户端字段级加密或 Queryable Encryption 加密，则 partialFilterExpression 不能引用加密字段。

您可以为所有 MongoDB索引类型指定 partialFilterExpression 选项。

sparse

布尔

可选。 如果为true，则索引仅引用具有指定字段的文档。这些索引使用的空间较少，但在某些情况下（尤其是排序），其行为会有所不同。 默认值为false 。有关更多信息，请参阅稀疏索引。

以下索引类型默认为稀疏索引，忽略此选项：

• 2dsphere

• 2d

• Text

对于包含 2dsphere 索引键以及其他类型的键的复合索引，只有 2dsphere 索引字段可确定索引是否引用文档。

MongoDB 提供了创建部分索引的选项。它们提供了稀疏索引功能的超集，因此是首选。

expireAfterSeconds

整型

可选。指定以秒为单位的生存时间 (TTL) 值，以便控制 MongoDB 在此集合中保留文档的时长。此选项仅会应用于 TTL 索引。请参阅通过设置 TTL 使集合中的数据过期以了解更多信息。

如果您使用 MongoDB 5.0 之前版本创建的 TTL 索引，或者要将 MongDB 5.0 创建的数据与之前版本同步，请参阅使用 NaN 配置索引，以避免错误配置问题。

TTL 索引 expireAfterSeconds 值必须介于 0 和 2147483647（包含两者）之间。

隐藏

布尔

可选。一个标志，用于确定索引是否对查询规划器隐藏。选择查询计划时不会对隐藏索引进行评估。

默认值为 false。

storageEngine

文档

可选。允许用户在创建索引时基于每个索引配置存储引擎。

storageEngine 选项应采用以下形式：

storageEngine: { <storage-engine-name>: <options> }

在复制过程中，对创建索引时指定的存储引擎配置选项进行验证并记录到 oplog 中，以支持包含使用不同存储引擎的成员的副本集。

weights

文档

可选。对于文本索引，指包含字段和权重对的文档。权重是一个介于 1 到 99,999 之间的整数，表示该字段相对于其他索引字段的得分重要性。您可以为部分或全部索引字段指定权重。请参阅为自管部署上的文本搜索结果分配权重来调整得分。默认值为 1。

default_language

字符串

Optional. For text indexes, the language that determines the list of stop words and the rules for the stemmer and tokenizer. See Text Search Languages on Self-Managed Deployments for the available languages and Specify Language for Text Indexes on Self-Managed MongoDB for more information and examples. The default value is english.

language_override

字符串

Optional. For text indexes, the name of the field, in the collection's documents, that contains the override language for the document. The default value is language. See Specify Language for Text Indexes on Self-Managed MongoDB for an example.

textIndexVersion

整型

可选。text 索引版本号。用户可以使用此选项覆盖默认版本号。

有关可用版本，请参阅自管理部署上的文本索引版本。

2dsphereIndexVersion

整型

可选。2dsphere 索引版本号。用户可以使用此选项覆盖默认版本号。

有关可用版本，请参阅 2dsphere 索引。

bits

整型

可选。对于 2d 索引，存储的位置数据的地理哈希值的精度数。

bits 值的范围为 1 到 32（含）。默认值为 26。

min

数字

可选。对于 2d 索引，这是经度和纬度值的包含下边界。默认值为 -180.0。

max

数字

可选。对于 2d 索引，这是经度和纬度值的包含上边界。默认值为 180.0。

collation

文档

可选。指定索引的排序规则。

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

如果在集合级别指定排序规则：

• 如果创建索引时未指定排序规则，MongoDB 将使用集合的默认排序规则创建索引。

• 如果您在创建索引时指定了排序规则，MongoDB 将使用指定的排序规则创建索引。

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

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

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

wildcardProjection

文档

可选。

允许用户使用 { "$**" : 1} 键模式在通配符索引中包括或排除特定的字段路径。只有在所有文档字段上创建通配符索引时，该选项才有效。如果在特定字段路径及其子字段上创建通配符索引，则无法指定该选项，例如 { "path.to.field.$**" : 1 }

wildcardProjection 选项采用以下形式：

wildcardProjection: {
  "path.to.field.a" : <value>,
  "path.to.field.b" : <value>
}

<value> 可以是以下任一项：

• 1 或 true 以将字段包含在通配符索引中。

• 0 或 false 以将该字段包含在通配符索引中。

默认情况下，通配符索引会省略 _id 字段。要将 _id 字段包含在通配符索引中，必须将其显式包含在 wildcardProjection 文档中：

{
  "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
  }
}

wildcardProjection 文档中的所有语句必须是包含语句或排除语句中的一种。您还可以在排除语句中包含 _id 字段。这是该规则的唯一例外。