db.collection.createIndexes()

在此页面上

定义

兼容性
选项
行为
例子
更多信息

带驱动程序的 MongoDB

本页面提供 mongosh 方法的相关信息。要查看 MongoDB 驱动程序中的等效方法，请参阅编程语言的相应页面：

C#Java Sync Node.js PyMongo C C++Go Java RS Kotlin Coroutine Kotlin Sync PHP Motor Mongoid Rust Scala Swift

定义

db.collection.createIndexes( [ keyPatterns ], options, commitQuorum )

在集合上创建一个或多个索引。

为了最大限度地减少构建索引对副本集和分片集群的影响，请使用滚动索引构建过程，如在副本集上构建滚动索引中所述。

db.collection.createIndexes() 使用以下参数：

Parameter

类型

说明

keyPatterns

文档

包含索引规范文档的数组。每个文档都包含字段和值对，其中字段是索引键，值描述该字段的索引类型。要对字段索引按升序排列，请指定值 1；要对索引按降序排列，请指定值 -1。

MongoDB 支持多种不同的索引类型，包括文本索引、地理空间索引和哈希索引。有关更多信息，请参阅索引类型。

在版本 4.2 中进行了更改：MongoDB 4.2通配符索引支持用户查询自定义字段或collection中的大量字段的工作负载：

要对文档中的所有字段和子字段创建通配符索引，请指定{ "$**" : 1 }作为索引键。创建通配符索引时不能指定降序索引键。
您还可以使用可选的wildcardProjection参数在索引中包含或排除特定字段及其子字段。
默认情况下，通配符索引会省略 _id 字段。要将 _id 字段包含在通配符索引中，必须将其显式包含在 wildcardProjection 文档中：
```
{
  "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
  }
}
```
除了显式包含_id字段之外，您不能在wildcardProjection文档中合并包含和排除声明。
您可以将特定字段的完整路径指定为索引键，并将"$**"附加到该路径，从而在该字段及其子路径上创建通配符索引：
{ "path.to.field.$**" : 1 }
创建通配符索引时不能指定降序索引键。
特定于路径的通配符索引语法与wildcardProjection选项不兼容。不能在指定路径上指定其他包含或排除内容。

通配符索引键必须使用上面列出的语法之一。例如，您不能指定复合索引键。有关通配符索引的更完整文档（包括创建限制），请参阅通配符索引限制。

mongod featureCompatibilityVersion必须为4.2才能创建通配符索引。有关设置 FCV 的说明，请参阅在 MongoDB 6.0 部署上设置特征兼容性版本。

有关创建通配符索引的更多信息，请参阅通配符索引。

options

文档

可选。包含一组控制索引创建的选项的文档。详见选项。

commitQuorum

整数或字符串

可选。承载数据的投票副本集成员的最小数量（即提交法定节点数），包括主节点，必须在主节点将indexes标记为就绪之前报告索引构建成功。“投票”成员是members[n].votes大于0的任何副本集成员。

支持以下值：

"votingMembers" - 所有承载数据的有投票权副本集成员（默认）。
"majority" - 数据承载投票副本集成员的简单多数制。
<int> - 特定数量的承载数据的副本集投票节点。
0 - 禁用法定人数投票行为。成员同时开始索引构建，但在完成索引构建之前不投票或等待法定人数。如果您使用 0 的提交法定人数启动索引构建，则以后无法使用 setIndexCommitQuorum 修改提交法定人数。
副本集标记名称。

兼容性

此方法可用于以下环境中托管的部署：

MongoDB Atlas：用于云中 MongoDB 部署的完全托管服务

注意

所有 MongoDB Atlas 集群都支持此命令。有关 Atlas 对所有命令的支持的信息，请参阅不支持的命令。

MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本
MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

Stable API

使用 Stable API V1 时：

您不能在 options 文档中指定以下任何字段：
- background
- bucketSize
- sparse
- storageEngine
无法创建 geoHaystack 或文本索引。
在严格模式，查询规划器会忽略上述不支持的索引类型。示例，尝试将sparse索引与cursor.hint()一起使用将导致以下BadValue错误：
```
planner returned error :: caused by :: hint provided does not
correspond to an existing index
```

选项

options 文档包含一组控制索引创建的选项。不同索引类型可以具备特定的附加选项。

同一文档中可指定多个索引选项。但是，如果指定多个选项文档，db.collection.createIndexes() 操作将失败。

请考虑下面的 db.collection.createIndexes() 操作：

db.collection.createIndexes(
   [
     {
       "a": 1
     },
     {
       "b": 1
     }
   ],
   {
     unique: true,
     sparse: true,
     expireAfterSeconds: 3600
   }
 )

如果选项规范被拆分为多个文档（如下所示： { unique: true }, { sparse: true, expireAfterSeconds: 3600 } ），索引创建操作将失败。

重要

如果将选项指定为 db.collection.createIndexes()，则这些选项适用于所有指定的索引。例如，如果指定排序规则选项，则创建的所有索引都将包含该排序规则。

db.collection.createIndexes() 会返回错误信息（如果您尝试使用不兼容的选项或过多参数创建索引）。请参阅选项说明以获取更多信息。

所有索引类型的选项

除非另有说明，否则以下选项可用于所有索引类型：

Parameter

类型

说明

unique

布尔

可选。指定 keyPatterns 数组中指定的每个索引都是唯一索引。唯一索引不会接受索引键值与索引中现有值匹配的文档的插入或更新。

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

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

name

字符串

可选。索引名称。如果未指定，MongoDB 将通过连接索引字段的名称和排序顺序来生成索引名称。

注意

在 MongoDB 4.2 中进行了更改

MongoDB 删除了最大127字节的索引名称长度限制。

为 db.collection.createIndexes() 指定的选项适用于键模式数组中包含的所有索引规范。由于索引名称必须唯一，因此，仅当使用 db.collection.createIndexes() 创建单个索引时才能指定名称。

partialFilterExpression

文档

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

过滤器表达式可以包括：

等式表达式（即 field: value 或使用 $eq操作符）、
$exists: true 表达式，
$gt, $gte, $lt, $lte expressions,
$type 表达式，
$and 操作符，
$or 操作符，
$in 运算符

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

sparse

布尔

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

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

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

提示

部分索引可提供比稀疏索引更多的功能。除非您的应用程序有特定要求，否则请使用部分索引而不是稀疏索引。

expireAfterSeconds

整型

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

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

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

隐藏

布尔

可选。一个标志，用于确定是否从查询规划器中隐藏索引。隐藏索引不会作为查询计划选择的一部分进行评估。

默认值为 false。

要使用hidden选项，必须将featureCompatibilityVersion设置为4.4或更大。但是，一旦隐藏，即使在 MongoDB 4.4 二进制文件上将 featureCompatibilityVersion设置为4.2 ，索引也会保持隐藏状态。

storageEngine

文档

可选。允许用户为创建的索引配置存储引擎。

storageEngine 选项应采用以下形式：

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

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

排序规则选项

Parameter

类型

说明

collation

文档

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

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

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

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

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

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

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

以下索引只支持简单的二进制比较，不支持排序规则：

文本索引，
2d索引，以及
geoHaystack索引。

提示

要在具有非简单排序规则的集合上创建text 、 2d或geoHaystack索引，您必须在创建索引时显式指定{collation: {locale: "simple"} } 。

排序规则和索引使用

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

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

提示

通过指定排序规则 strength 为 1 或 2，您可以创建不区分大小写的索引。排序规则 strength 为 1 的索引既不区分变音符号，也不区分大小写。

您可以使用不同的排序规则对同一键创建多个索引。要创建具有相同键模式但不同排序规则的索引，您必须提供唯一索引名称。

要使用索引进行字符串比较，操作还必须指定相同的排序规则。换言之，如果一个操作对索引字段进行字符串比较，但又设定了与索引字段不同的排序规则，那么这个设有排序规则的索引将无法支持该操作。

警告

由于配置了排序规则的索引是通过 ICU 排序规则键来实现排序，因此，相比未配置排序规则的索引的索引键，有排序规则感知的索引键可能会更大。

例如，集合 myColl 在字符串字段 category 上具有一个索引，排序规则语言环境为 "fr"。

db.myColl.createIndex( { category: 1 }, { collation: { locale: "fr" } } )

以下查询操作指定了与索引相同的排序规则，因此可以使用索引：

db.myColl.find( { category: "cafe" } ).collation( { locale: "fr" } )

而以下查询操作默认使用“简易的”二进制排序器，因此无法使用索引：

db.myColl.find( { category: "cafe" } )

如果一个复合索引的前缀键不是字符串、数组和嵌入式文档，在这种情况下，即使查询操作指定了一个与索引不同的排序规则，它仍然可以利用该复合索引来支持对其前缀健的比较。

例如，集合 myColl 在数值字段 score 和 price 以及字符串字段 category 上有一个复合索引；该索引使用排序规则语言环境 "fr" 创建，用于进行字符串比较：

db.myColl.createIndex(
   { score: 1, price: 1, category: 1 },
   { collation: { locale: "fr" } } )

以下操作使用 "simple" 二进制排序规则进行字符串比较，它们可以使用索引：

db.myColl.find( { score: 5 } ).sort( { price: 1 } )
db.myColl.find( { score: 5, price: { $gt: NumberDecimal( "10" ) } } ).sort( { price: 1 } )

以下操作使用 "simple" 二进制排序规则对索引的 category 字段进行字符串比较，它们可以使用索引仅完成查询的 score: 5 部分：

db.myColl.find( { score: 5, category: "cafe" } )

重要

与文档键（包括嵌入式文档键）的匹配使用简单的二进制比较。这意味着类似“foo.bár”的键的查询不会匹配“foo.bar”键，无论您为 strength 参数设置了什么值。

`text`索引的选项

以下选项仅适用于文本索引：

Parameter	类型	说明
`weights`	文档	可选。对于文本索引，指包含字段和权重对的文档。权重是一个介于 1 到 99,999 之间的整数，表示该字段相对于其他索引字段的得分重要性。您可以为部分或全部索引字段指定权重。请参阅为自管部署上的文本搜索结果分配权重来调整得分。默认值为 `1`。从 MongoDB 5.0 开始，只有文本索引才允许使用 weights 选项。
`default_language`	字符串	可选。对于文本索引，确定停止词列表的语言以及词干分析器和分词器的规则。欲了解更多信息和示例，请参阅自管理部署上的文本搜索语言和为自管理部署上的文本索引指定默认语言。默认值为 `english`。
`language_override`	字符串	可选。对于文本索引，为collection文档中包含文档覆盖语言的字段的名称。默认值为`language` 。有关示例，请参阅使用任何字段指定文档的语言。
`textIndexVersion`	整型	可选。`text` 索引版本号。用户可以使用此选项覆盖默认版本号。有关可用版本，请参阅版本。

`2dsphere`索引的选项

以下选项仅适用于 2dsphere 索引：

Parameter	类型	说明
`2dsphereIndexVersion`	整型	可选。`2dsphere` 索引版本号。用户可以使用此选项覆盖默认版本号。有关可用版本，请参阅版本。

`2d`索引的选项

以下选项仅适用于 2d 索引：

Parameter	类型	说明
`bits`	整型	可选。对于 2d 索引，存储的位置数据的地理哈希值的精度数。 `bits` 值的范围为 1 到 32（含）。默认值为 `26`。
`min`	数字	可选。对于 2d 索引，这是经度和纬度值的包含下边界。默认值为 `-180.0`。
`max`	数字	可选。对于 2d 索引，这是经度和纬度值的包含上边界。默认值为 `180.0`。

`geoHaystack`索引的选项

以下选项仅适用于geoHaystack索引：

Parameter	类型	说明
`bucketSize`	数字	对于geoHaystack索引，请指定对位置值进行分组的单位数量；即将彼此在指定单位数内的位置值分组在同一个存储桶中。该值必须大于 0。

注意

已在 MongoDB 5.0 中删除

MongoDB 5.0 删除了已弃用的geoHaystack索引和geoSearch命令。请改用带有的 2d $geoNear索引或受支持的地理空间查询操作符之一。

将 MongoDB 实例升级到 5.0 并将 FeatureCompatibilityVersion 设置为 5.0 会删除所有先前存在的 geoHaystack 索引。

`wildcard`索引的选项

以下选项仅适用于通配符索引：

Parameter

类型

说明

wildcardProjection

文档

可选。允许用户在通配符索引中包含或排除特定的字段路径（Field Path）。此选项仅在创建通配符索引时有效。

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
  }
}

除了显式包含_id字段之外，您不能在wildcardProjection文档中合并包含和排除声明。

为 db.collection.createIndexes() 指定的选项适用于键模式数组中包含的所有索引规范。仅在使用 db.collection.createIndexes(). 创建单个通配符索引时才指定 wildcardProjection。

行为

并发

版本 4.2 中进行了更改。

MongoDB 使用优化的构建过程，在索引构建开始和结束时获取并持有指定集合的独占锁。对集合的所有后续操作都必须等到createIndexes()释放独占锁。 createIndexes()允许在索引构建的大部分过程中交替执行读取和写入操作。

有关 createIndexes()的锁定行为的更多信息，请参阅在填充集合上构建索引。

重新创建现有索引

如果为已存在的一个或多个索引调用 db.collection.createIndexes()，则 MongoDB 不会重新创建现有的一个或多个索引。

索引选项

非排序和非隐藏选项

除排序规则选项外，如果使用一组索引选项创建一个索引，然后尝试使用其他索引选项重新创建同一索引，MongoDB 不会更改选项，也不会重新创建索引。

可以在不删除和重新创建索引的情况下更改隐藏选项。请参阅隐藏选项。

要更改其他索引选项，请先使用 db.collection.dropIndex() 删除现有索引，然后使用新选项运行 db.collection.createIndexes()。

排序规则选项

您可以使用不同的排序规则对同一键创建多个索引。要创建具有相同键模式但不同排序规则的索引，您必须提供唯一索引名称。

隐藏选项

4.4 版本新增。

要隐藏或取消隐藏现有索引，可使用以下 mongosh 方法：

例如，

要将索引的 hidden 选项更改为 true，请使用 db.collection.hideIndex() 方法：
```
db.restaurants.hideIndex( { borough: 1, ratings: 1 } );
```
要将索引的 hidden 选项更改为 false，请使用 db.collection.unhideIndex() 方法：
```
db.restaurants.unhideIndex( { borough: 1, city: 1 } );
```

提示

另请参阅：

Hidden Indexes

通配符索引 (Wildcard Indexes)

4.2 版本中的新增功能。

默认情况下，通配符索引会省略 _id 字段。要将 _id 字段包含在通配符索引中，必须将其显式包含在 wildcardProjection 文档中：
```
{
  "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
  }
}
```
除了显式包含_id字段之外，您不能在wildcardProjection文档中合并包含和排除声明。
mongod featureCompatibilityVersion必须为4.2才能创建通配符索引。有关设置 FCV 的说明，请参阅在 MongoDB 6.0 部署上设置特征兼容性版本。
通配符索引不支持以下索引类型或属性：
注意
通配符索引不同于通配符文本索引，并且与通配符文本索引不兼容。通配符索引不支持使用 $text 操作符的查询。
有关通配符索引限制的完整文档，请参阅通配符索引限制。

有关创建通配符索引的示例，请参阅创建通配符索引。有关通配符索引的完整文档，请参阅通配符索引。

事务

如果事务不是跨分片写事务，则可以在分布式事务中创建集合和索引。

要在事务中使用 db.collection.createIndexes()，该事务必须使用读关注 "local"。如果指定 "local" 以外的读关注级别，则该事务将失败。

提示

另请参阅：

在事务中创建集合和索引

例子

提示

另请参阅：

db.collection.createIndex() 以获取各种索引规格的示例。

在不使用选项的情况下创建索引

考虑包含类似于以下内容的文档的restaurants集合：

{
   location: {
      type: "Point",
      coordinates: [-73.856077, 40.848447]
   },
   name: "Morris Park Bake Shop",
   cuisine: "Cafe",
   borough: "Bronx",
}

以下示例在 restaurants 集合上创建两个索引：在 borough 字段上创建升序索引，在 location 字段上创建 2dsphere 索引。

db.restaurants.createIndexes([{"borough": 1}, {"location": "2dsphere"}])

使用指定排序规则创建索引

以下示例对 products 集合创建两个索引：对 manufacturer 字段创建升序索引，对 category 字段创建升序索引。两个索引都使用排序规则，用于指定区域设置 fr 和比较强度 2：

db.products.createIndexes( [ { "manufacturer": 1}, { "category": 1 } ],
   { collation: { locale: "fr", strength: 2 } })

对于使用相同排序规则的索引键的查询或排序操作，MongoDB 可以使用索引。有关详细信息，请参阅排序规则和索引使用。

创建通配符索引

版本 4.2 中的新增功能： mongod featureCompatibilityVersion必须为4.2才能创建通配符索引。有关设置 FCV 的说明，请参阅在 MongoDB 6.0 部署上设置特征兼容性版本。

有关“通配符索引”的完整文档，请参阅“通配符索引”。

下面列出了创建通配符索引的示例：

对单个字段路径（Field Path）创建通配符索引
对所有字段路径创建通配符索引
在多个特定字段路径上创建通配符索引
创建排除多个特定字段路径的通配符索引

对单个字段路径（Field Path）创建通配符索引

以某一 products_catalog 集合为例，其中的文档可能包含 product_attributes 字段。product_attributes 字段可包含任意嵌套字段，其中包括嵌入式文档文档和数组：

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Blaster Gauntlet",
    product_attributes: {
      price: {
        cost: 299.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Super Suit",
    product_attributes: {
      superFlight: true,
      resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
    }
  }
] )

以下操作在 product_attributes 字段上创建一个通配符索引：

use inventory
db.products_catalog.createIndexes(
  [ { "product_attributes.$**" : 1 } ]
)

通过此通配符索引，MongoDB 可以对 product_attributes 的所有标量值建立索引。如果字段是嵌套文档或数组，则通配符索引将递归到文档/数组中，并为文档/数组中的所有标量字段建立索引。

通配符索引可以支持对 product_attributes 或其嵌套字段之一进行任意单字段查询：

db.products_catalog.find( { "product_attributes.superFlight" : true } )
db.products_catalog.find( { "product_attributes.maxSpeed" : { $gt : 20 } } )
db.products_catalog.find( { "product_attributes.elements" : { $eq: "water" } } )

注意

特定于路径的通配符索引语法与 wildcardProjection 选项不兼容。有关更多信息，请参阅参数文档。

对所有字段路径创建通配符索引

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Blaster Gauntlet",
    product_attributes: {
      price: {
        cost: 299.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Super Suit",
    product_attributes: {
      superFlight: true,
      resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
    }
  }
] )

以下操作对所有标量字段（不包括 _id 字段）创建通配符索引：

use inventory
db.products_catalog.createIndexes(
  [ { "$**" : 1 } ]
)

通过此通配符索引，MongoDB 可为集合中每个文档的所有标量字段建立索引。如果给定字段是嵌套文档或数组，则通配符索引将递归到文档/数组中并对文档/数组中的所有标量字段构建索引。

创建的索引可以支持对集合中文档内任意字段的查询：

db.products_catalog.find( { "product_price" : { $lt : 25 } } )
db.products_catalog.find( { "product_attributes.elements" : { $eq: "water" } } )

注意

默认情况下，通配符索引会省略 _id 字段。要将 _id 字段包含在通配符索引中，则必须将其明确包含在wildcardProjection文档中。查看参数文档以获取更多信息。

在多个特定字段路径上创建通配符索引

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Blaster Gauntlet",
    product_attributes: {
      price: {
        cost: 299.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Super Suit",
    product_attributes: {
      superFlight: true,
      resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
    }
  }
] )

以下操作创建通配符索引并使用wildcardProjection选项，以仅在索引中包含product_attributes.elements和product_attributes.resistance字段的标量值。

use inventory
db.products_catalog.createIndexes(
  [ { "$**" : 1 } ],
  {
    "wildcardProjection" : {
      "product_attributes.elements" : 1,
      "product_attributes.resistance" : 1
    }
  }
)

虽然键模式"$**"涵盖了文档中的所有字段，但wildcardProjection字段将索引限制为仅包含所包含的字段。有关wildcardProjection的完整文档，请参阅wildcard索引的选项。

如果字段是嵌套文档或数组，则通配符索引将递归到文档/数组中并对文档/数组中的所有标量字段构建索引。

创建的索引可支持对 wildcardProjection 中包含的任何标量字段查询：

db.products_catalog.find( { "product_attributes.elements" : { $eq: "Water" } } )
db.products_catalog.find( { "product_attributes.resistance" : "Bludgeoning" } )

注意

通配符索引不支持在 wildcardProjection 文档中混用包含和排除语句，除非显示包含 _id 字段时。有关 wildcardProjection 的更多信息，请参阅参数文档。

创建排除多个特定字段路径的通配符索引

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Blaster Gauntlet",
    product_attributes: {
      price: {
        cost: 299.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Super Suit",
    product_attributes: {
      superFlight: true,
      resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
    }
  }
] )

以下操作可创建通配符索引，并使用 wildcardProjection 文档对集合中每个文档的所有标量字段进行索引，不包括 product_attributes.elements 和 product_attributes.resistance 字段：

use inventory
db.products_catalog.createIndexes(
  [ { "$**" : 1 } ],
  {
    "wildcardProjection" : {
      "product_attributes.elements" : 0,
      "product_attributes.resistance" : 0
    }
  }
)

键模式"$**"涵盖了文档中的所有字段，而wildcardProjection字段则从索引中排除了指定字段。有关wildcardProjection的完整文档，请参阅wildcard索引的选项。

如果字段是嵌套文档或数组，则通配符索引将递归到文档/数组中并对文档/数组中的所有标量字段构建索引。

创建的索引可以支持对任何标量字段的查询，但 wildcardProjection 排除的字段除外：

db.products_catalog.find( { "product_attributes.maxSpeed" : { $gt: 25 } } )
db.products_catalog.find( { "product_attributes.superStrength" : true } )

注意

通配符索引不支持在 wildcardProjection 文档中混用包含和排除语句，除非显示包含 _id 字段时。有关 wildcardProjection 的更多信息，请参阅参数文档。

使用提交法定人数创建索引

注意

需要 featureCompatibilityVersion 4.4+

副本集或分片集群中的每个 mongod 必须将 featureCompatibilityVersion 设置为至少 4.4，才能跨副本集节点同时启动索引构建。

索引构建在副本集或分片集群上，并在所有数据承载副本集成员上同时构建。对于分片集群，索引构建仅会在包含当前被索引集合的数据的分片上进行。主节点需要最少数量的数据承载 voting 节点（即提交法定节点数），包括其自身，这些节点必须在将索引标记为可供使用之前完成构建。有关详细信息，请参阅复制环境中的索引构建。

为操作指定createIndexes() commitQuorum 参数，以设置承载数据的投票节点（即提交法定节点数）（包括主节点）的最小数量，主节点必须在主节点将索引标记为就绪之前完成索引构建。默认提交法定人数为votingMembers ，或所有承载数据的投票副本集节点。

以下操作将创建提交法定人数为 "majority" 的索引：

db.getSiblingDB("examples").invoices.createIndexes(
  { "invoices" : 1 },
  { },
  "majority"
)

仅在简单多数承载数据的投票成员“投票”提交索引构建后，主节点才会将索引构建标记为准备就绪。有关索引构建和投票过程的更多信息，请参阅复制环境中的索引构建。

创建多个索引

创建cakeSales集合，其中包含加利福尼亚州 ( CA ) 和华盛顿州 ( WA ) 的蛋糕销售情况：

db.cakeSales.insertMany( [
   { _id: 0, type: "chocolate", orderDate: new Date("2020-05-18T14:10:30Z"),
     state: "CA", price: 13, quantity: 120 },
   { _id: 1, type: "chocolate", orderDate: new Date("2021-03-20T11:30:05Z"),
     state: "WA", price: 14, quantity: 140 },
   { _id: 2, type: "vanilla", orderDate: new Date("2021-01-11T06:31:15Z"),
     state: "CA", price: 12, quantity: 145 },
   { _id: 3, type: "vanilla", orderDate: new Date("2020-02-08T13:13:23Z"),
     state: "WA", price: 13, quantity: 104 },
   { _id: 4, type: "strawberry", orderDate: new Date("2019-05-18T16:09:01Z"),
     state: "CA", price: 41, quantity: 162 },
   { _id: 5, type: "strawberry", orderDate: new Date("2019-01-08T06:12:03Z"),
     state: "WA", price: 43, quantity: 134 }
] )

以下示例将对 cakeSales 集合创建多个索引：

db.cakeSales.createIndexes( [
   { "type": 1 },
   { "orderDate": 1 },
   { "state": 1 },
   { "orderDate": 1, "state": -1 }
] )

前三个索引位于单个字段上，并按升序排列 (1)。

最后一个索引位于 orderDate 上，并按升序排列 (1)；位于 state 上，并按降序排列 (-1)。

定义

兼容性

注意

Stable API

选项

重要

所有索引类型的选项

注意

在 MongoDB 4.2 中进行了更改

提示

排序规则选项

提示

排序规则和索引使用

提示

警告

重要

text索引的选项

2dsphere索引的选项

2d索引的选项

geoHaystack索引的选项

注意

已在 MongoDB 5.0 中删除

wildcard索引的选项

行为

并发

重新创建现有索引

索引选项

非排序和非隐藏选项

排序规则选项

隐藏选项

提示

另请参阅：

通配符索引 (Wildcard Indexes)

注意

事务

提示

另请参阅：

例子

提示

另请参阅：

在不使用选项的情况下创建索引

使用指定排序规则创建索引

创建通配符索引

对单个字段路径（Field Path）创建通配符索引

注意

对所有字段路径创建通配符索引

注意

在多个特定字段路径上创建通配符索引

注意

创建排除多个特定字段路径的通配符索引

注意

使用提交法定人数创建索引

注意

需要 featureCompatibilityVersion 4.4+

创建多个索引

更多信息

`text`索引的选项

`2dsphere`索引的选项

`2d`索引的选项

`geoHaystack`索引的选项

`wildcard`索引的选项