createIndexes

在此页面上

定义

语法
命令字段
考虑因素
索引名称
副本集和分片集群
排序规则和索引类型
Stable API
行为
并发
内存使用限制
索引选项
通配符索引 (Wildcard Indexes)
事务
提交法人数与写关注的对比
例子
创建通配符索引
使用提交法定人数创建索引
输出

定义

createIndexes: 为集合构建一个或多个索引。
提示
在 mongosh中，该命令也可以通过db.collection.createIndex()和db.collection.createIndexes()辅助方法运行。
助手方法对于mongosh用户来说很方便，但它们返回的信息级别可能与数据库命令不同。如果不追求方便或需要额外的返回字段，请使用数据库命令。

语法

createIndexes命令采用以下形式：

db.runCommand(
   {
     createIndexes: <collection>,
     indexes: [
         {
             key: {
                 <key-value_pair>,
                 <key-value_pair>,
                 ...
             },
             name: <index_name>,
             <option1>,
             <option2>,
             ...
         },
         { ... },
         { ... }
     ],
     writeConcern: { <write concern> },
     commitQuorum: <int|string>,
     comment: <any>
   }
 )

命令字段

createIndexes命令采用以下字段：

字段	类型	说明
`createIndexes`	字符串	要创建索引的集合。
`indexes`	阵列	指定要创建的索引。数组中的每个文档都指定一个单独的索引。
`writeConcern`	文档	可选。表达写关注的文档。省略以使用默认写关注。
`commitQuorum`	整数或字符串	可选。承载数据的副本集成员的最小数量（即提交法定节点数），包括主节点，必须在主节点将 `indexes` 标记为就绪之前报告索引构建成功。从 MongoDB v5.0 开始，您可以在`commit quorum is set`为`"votingMembers"`时，恢复一些中断的索引构建。提交法定人数中的副本集节点必须将 `members[n].buildIndexes` 设置为 `true`。如果任何投票节点将 `members[n].buildIndexes`设置为 `false`，则无法使用默认 `"votingMembers"` 提交法定人数。配置所有节点以将 `members[n].buildIndexes` 设置为 `true`，或者选择不同的提交法定人数。支持以下值： `"votingMembers"` - 所有承载数据的有投票权副本集成员（默认）。“投票”成员是 `members[n].votes` 大于 `0` 的任何副本集成员。 `"majority"` - 数据承载投票副本集成员的简单多数制。 `<int>` - 特定数量的承载数据的副本集节点。 `0` - 禁用法定人数投票行为。成员同时开始索引构建，但在完成索引构建之前不投票或等待法定人数。如果您使用 `0` 的提交法定人数启动索引构建，则以后无法使用 `setIndexCommitQuorum` 修改提交法定人数。副本集标记名称。
`comment`	注意到	可选。用户提供的待附加到该命令的注释。设置后，该注释将与该命令的记录一起出现在以下位置： mongod 日志消息，位于 `attr.command.cursor.comment` 字段中。 `command.comment` 字段中的数据库分析器输出。 `currentOp` 输出，在 `command.comment` 字段。注释可以是任何有效的 BSON 类型（字符串、整型、对象、数组等）。

indexes 数组中的每个文档都可以采用以下字段：

字段

类型

说明

key

文档

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

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

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

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

您可以为特定字段及其子路径或文档中的所有字段创建通配符索引。
有关详细信息，请参阅通配符索引。

name

字符串

唯一地标识索引的名称。

unique

布尔

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

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

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

partialFilterExpression

文档

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

过滤器表达式可以包括：

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

如果您使用的是客户端字段级加密或可查询加密，则partialFilterExpression无法引用加密字段。

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

sparse

布尔

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

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

对于包含 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

字符串

可选。对于文本索引，确定停止词列表的语言以及词干分析器和分词器的规则。有关可用语言的信息，请参阅文本搜索语言，欲了解更多信息和示例，请参阅为文本索引指定默认语言。默认值为 english。

language_override

字符串

可选。对于文本索引，则为集合的文档中包含文档替代语言的字段的名称。默认值为 language。请参阅为文本索引指定默认语言以查看示例。

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 字段。这是该规则的唯一例外。

mongosh提供方法db.collection.createIndex()和db.collection.createIndexes()作为createIndexes命令的包装器。

考虑因素

MongoDB 不允许创建0版本的索引。

索引名称

如果您使用一个名称创建索引，然后尝试使用其他名称再次创建相同索引，则createIndexes命令以及mongosh助手db.collection.createIndex()和db.collection.createIndexes()会报告错误。

{
   "ok" : 0,
   "errmsg" : "Index with name: x_1 already exists with a different name",
   "code" : 85,
   "codeName" : "IndexOptionsConflict"
}

在以前的版本中，MongoDB 不会再次创建索引，但会返回 ok 值为 1 的响应对象以及暗示未重新创建索引的注释。例如：

{
   "numIndexesBefore" : 2,
   "numIndexesAfter" : 2,
   "note" : "all indexes already exist",
   "ok" : 1
}

副本集和分片集群

注意

需要 featureCompatibilityVersion 4.4+

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

索引构建在副本集或分片集群上，同时在所有承载数据的副本集成员上构建。对于分片集群，索引构建仅在包含正在索引的collection的数据的分片上进行。主节点需要最少数量的承载数据的voting成员（即commit quorum），包括其自身，这些成员必须在将索引标记为可供使用之前完成构建。有关更多信息，请参阅副本环境中的索引构建。

要使用非默认提交法定人数启动索引构建，请指定commitQuorum。

使用setIndexCommitQuorum命令修改正在进行的索引构建的提交法定人数。

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

排序规则和索引类型

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

文本索引
2d 索引

提示

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

Stable API

使用 Stable API V1 时：

您不能在 indexes 数组中指定以下任何字段：
- background
- bucketSize
- sparse
- storageEngine
无法创建 geoHaystack 或文本索引。

行为

并发

对于featureCompatibilityVersion "4.2" ， createIndexes使用优化的构建过程，该过程在索引构建开始和结束时获取并保持对指定集合的独占锁。对集合的所有后续操作都必须等到createIndexes释放独占锁。 createIndexes允许在索引构建的大部分时间交错读取和写入操作。

对于featureCompatibilityVersion "4.0" ， createIndexes使用4之前的版本。 2索引构建过程，默认情况下会在整个构建过程中获得对父数据库的独占锁。前4 。 2构建进程会阻止对数据库及其所有集合的所有操作，直到该操作完成。 background索引不采用独占锁。

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

内存使用限制

createIndexes支持在集合上构建一个或多个索引。 createIndexes使用内存和磁盘上的临时文件的组合来完成索引构建。 createIndexes的默认内存使用限制为200兆字节（对于版本4 . 2 . 3及更高版本）和500 （对于版本4 . 2 . 2和更早版本），在使用单个createIndexes命令构建的所有索引之间共享。达到内存限制后， createIndexes将使用--dbpath目录中名为_tmp的子目录中的临时磁盘文件来完成构建。

您可以通过设置 maxIndexBuildMemoryUsageMegabytes 服务器参数来覆盖内存限制。设置更高的内存限制可能会加快完成索引构建过程。但是，相对于系统上未使用的 RAM 而言，将此限制设置得太高可能会导致内存耗尽和服务器关闭。

索引选项

非隐藏选项

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

更改索引选项

可以更新现有索引的排序规则选项。要更改其他索引选项，请使用db.collection.dropIndex()删除现有索引，然后使用新选项运行createIndexes 。

排序规则选项

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

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

如果创建索引时未指定排序规则，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 参数设置了什么值。

隐藏选项

要更改现有索引的hidden选项，可以使用以下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)

默认情况下，通配符索引会省略 _id 字段。要将 _id 字段包含在通配符索引中，必须将其显式包含在 wildcardProjection 文档中：
```
{
  "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
  }
}
```
wildcardProjection 文档中的所有语句必须是包含语句或排除语句中的一种。您还可以在排除语句中包含 _id 字段。这是该规则的唯一例外。
不支持通配符索引：
通配符索引是稀疏(Sparse)索引。当索引字段不存在时，它们不支持查询。如果通配符字段的值为 null，则通配符索引将对文档进行索引。
从 MongoDB 7.0 开始，通配符索引支持升序 (1) 和降序 (-1) 排序顺序。早期版本仅支持升序。

要了解详情，请参阅：

事务

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

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

提示

另请参阅：

在事务中创建集合和索引

提交法人数与写关注的对比

提交法定人数和写关注之间有重要区别：

索引构建使用提交法定人数。
写入操作使用写关注。

集群中的每个承载数据的节点均为一个有投票权成员。

提交法定人数指定了必须准备多少个承载数据的有投票权成员或是哪些有投票权成员（包括主节点）来提交同步索引构建。主节点才会执行提交。

写关注是指确认写入操作已传播到指定数量的实例的级别。

提交法定人数指定了在主节点提交索引构建之前必须有多少个节点准备好完成索引构建。相反，当主节点已提交索引构建时，写关注则指定了在此命令返回之前有多少个节点必须完成索引构建。

例子

以下命令会在 products 数据库的 inventory 集合上构建两个索引：

db.getSiblingDB("products").runCommand(
  {
    createIndexes: "inventory",
    indexes: [
        {
            key: {
                item: 1,
                manufacturer: 1,
                model: 1
            },
            name: "item_manufacturer_model",
            unique: true
        },
        {
            key: {
                item: 1,
                supplier: 1,
                model: 1
            },
            name: "item_supplier_model",
            unique: true
        }
    ],
    writeConcern: { w: "majority" }
  }
)

在索引成功完成构建时，MongoDB 返回一个结果文档，其中包含 "ok" : 1 状态。

创建通配符索引

注意

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

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

对单个字段路径（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.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "product_attributes.$**" : 1 },
        name: "wildcardIndex"
      }
    ]
  }
)

通过此通配符索引，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.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "$**" : 1 },
        name: "wildcardIndex"
      }
    ]
  }
)

通过此通配符索引，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.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "$**" : 1 },
        "wildcardProjection" : {
          "product_attributes.elements" : 1,
          "product_attributes.resistance" : 1
        },
        name: "wildcardIndex"
      }
    ]
  }
)

虽然键模式 "$**" 涵盖了文档中的所有字段，但 wildcardProjection 字段将索引限制为只有所包含的字段及其嵌套字段。

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

创建的索引可支持对 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.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "$**" : 1 },
        "wildcardProjection" : {
           "product_attributes.elements" : 0,
           "product_attributes.resistance" : 0
        },
        name: "wildcardIndex"
      }
    ]
  }
)

键模式"$**"涵盖文档中的所有字段，而wildcardProjection字段则从索引中排除指定字段。

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

创建的索引可以支持对任何标量字段的查询，但 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，才能跨副本集节点同时启动索引构建。

要设置提交法定人数，请使用createIndexes指定commitQuorum值。

commitQuorum 指定在主成员执行提交之前必须准备好多少个承载数据的投票成员或哪些投票成员（包括主节点）来提交索引构建。默认提交法定人数为 votingMembers，这意味着是所有承载数据的成员。

以下操作创建提交法定人数为"majority"或简单多数承载数据的成员的索引：

db.getSiblingDB("examples").runCommand(
  {
    createIndexes: "invoices",
    indexes: [
      {
        key: { "invoices" : 1 },
        "name" : "invoiceIndex"
      }
    ],
    "commitQuorum" : "majority"
  }
)

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

输出

createIndexes命令会返回一个文档，指示操作成功。该文档包含以下部分（但不是全部）字段，具体取决于结果：

createIndexes.createdCollectionAutomatically: 如果为 true，则该集合不存在，并且是索引创建过程中创建的。

createIndexes.numIndexesBefore: 命令开头的索引数。

createIndexes.numIndexesAfter: 命令结尾的索引数。

createIndexes.ok: 值为 1 表示索引已就位。值为 0 表示出现错误。

createIndexes.note: 如果已存在一个或多个索引，则返回 note。这表示未创建或更改索引。

createIndexes.errmsg: 返回有关任何错误的信息。

createIndexes.code: 代表错误类型的错误代码。

← 创建

currentOp →

createIndexes.css-134mg1q{-webkit-align-self:center;-ms-flex-item-align:center;align-self:center;padding:0 10px;visibility:hidden;}.css-6vrlzm{border-radius:0!important;display:initial!important;margin:initial!important;}.css-1l4s55v{margin-top:-175px;position:absolute;padding-bottom:2px;}

定义

提示

语法

命令字段

考虑因素

索引名称

副本集和分片集群

注意

需要 featureCompatibilityVersion 4.4+

排序规则和索引类型

提示

Stable API

行为

并发

内存使用限制

索引选项

非隐藏选项

更改索引选项

排序规则选项

提示

警告

重要

隐藏选项

提示

另请参阅：

通配符索引 (Wildcard Indexes)

事务

提示

另请参阅：

提交法人数与写关注的对比

例子

创建通配符索引

注意

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

注意

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

注意

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

注意

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

注意

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

注意

需要 featureCompatibilityVersion 4.4+

输出

createIndexes