createIndexes

定义¶

createIndexes¶

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

该createIndexes命令采用以下形式：

复制

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

该createIndexes命令包含以下字段：

领域	类型	描述
createIndexes	串	要为其创建索引的集合。
indexes	数组	指定要创建的索引。数组中的每个文档都指定一个单独的索引。
writeConcern	文献	可选的。表达书面关切的文件。省略使用默认的写关注。 3.4版的新功能。

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

领域	类型	描述
key	文献	指定索引的字段。对于每个字段，请指定一个键值对，其中key是要索引的字段的名称，值是index direction或index type。如果指定方向，则指定1升序还是-1降序。 MongoDB支持几种不同的索引类型，包括 text，geospatial和hashed索引。有关 更多信息，请参见索引类型。 在版本4.2中进行了更改： MongoDB 4.2 通配符索引 支持工作负载，用户可以在其中查询自定义字段或集合中多种字段： 要在文档的所有字段和子字段上创建通配符索引，请指定作为索引键。创建通配符索引时，不能指定降序索引键。{ "$**" : 1 } 您还可以使用可选参数从索引中包含或排除特定字段及其子字段 wildcardProjection。 _id默认情况下，通配符索引会忽略该字段。要将_id字段包括 在通配符索引中，必须在wildcardProjection文档中明确包含它： 复制 { "wildcardProjection" : { "_id" : 1, "<field>" : 0|1 } } 除了显式包含 _id字段外，您无法在wildcardProjection文档中组合包含和排除语句 。 您可以在特定字段及其子路径上创建通配符索引，方法是将该字段的完整路径指定为索引键并附"$**"加到该路径： { "path.to.field.$**" : 1 } 创建通配符索引时，不能指定降序索引键。 特定于路径的通配符索引语法与该wildcardProjection选项不兼容 。您不能在指定的路径上指定其他包含或排除。 通配符索引键必须使用上面列出的语法之一。例如，您不能指定 复合索引键。有关通配符索引的更完整文档（包括对其创建的限制），请参见通配符索引限制。 该featureCompatibilityVersion必须创建通配符索引。有关设置fCV的说明，请参阅 在MongoDB 4.2部署上设置功能兼容版本。mongod 4.2 有关创建通配符索引的示例，请参见 创建通配符索引。
name	串	唯一标识索引的名称。
background	布尔值	可选的。在MongoDB 4.2中已弃用。 对于功能兼容版本（fcv） "4.0"，指定可指示MongoDB在后台构建索引。后台构建 不会阻止对集合的操作。默认值为 。background: truefalse 在版本4.2中进行了更改。 对于功能兼容版本（fcv） "4.2"，所有索引构建都使用优化的 构建过程，该过程仅在构建过程的开始和结束时才保留排他锁。其余的构建过程将产生交错的读写操作。background如果指定，MongoDB将忽略该选项。
unique	布尔值	可选的。创建唯一索引，以便在索引键值与索引中现有值匹配的集合中，该集合将不接受文档的插入或更新。 指定true以创建唯一索引。默认值为false。 该选项不适用于哈希 索引。
partialFilterExpression	文献	可选的。如果指定，则索引仅引用与过滤器表达式匹配的文档。有关更多信息，请参见部分索引。 过滤器表达式可以包括： 等式表达式（即或使用 运算符），field: value$eq $exists: true 表达， $gt，$gte，$lt，$lte表情， $type 表达式， $and 仅限顶级运营商 您可以partialFilterExpression为所有MongoDB 索引类型指定一个选项 。 3.2版中的新功能。
sparse	布尔值	可选的。如果为true，则索引仅引用具有指定字段的文档。这些索引使用较少的空间，但是在某些情况下（尤其是排序）表现不同。默认值为false。有关更多信息，请参见稀疏索引。 默认情况下，以下索引类型是稀疏的，并且忽略此选项： 2dsphere 2d geoHaystack 文本 对于包含2dsphere索引键和其他类型的键的复合索引，只有2dsphere索引字段才能确定索引是否引用文档。 在版本3.2中进行了更改：从MongoDB 3.2开始，MongoDB提供了创建部分索引的选项 。部分索引提供了稀疏索引功能的超集。如果您使用的是MongoDB 3.2或更高版本，则应优先使用部分索引而不是稀疏索引。
expireAfterSeconds	整数	可选的。指定一个值（以秒为单位）作为TTL，以控制MongoDB在此集合中保留文档的时间。有关此功能的更多信息，请参见 通过设置TTL从集合中过期数据。这仅适用于TTL索引。
storageEngine	文献	可选的。允许用户在创建索引时基于每个索引配置存储引擎。 该storageEngine选项应采用以下形式： 复制 storageEngine: { <storage-engine-name>: <options> } 创建索引时进行验证，并记录到指定的存储引擎的配置选项OPLOG复制到支持副本集与使用不同的存储引擎成员中。
weights	文献	可选的。对于文本索引，是包含字段和权重对的文档。权重是一个介于1到99,999之间的整数，表示得分相对于其他索引字段的字段的重要性。您可以为某些或所有索引字段指定权重。请参阅 使用权重控制搜索结果以调整分数。默认值为1。
default_language	串	可选的。对于文本索引，该语言用于确定停用词列表以及词干分析器和令牌生成器的规则。有关更多信息和示例，请参见文本搜索语言以获取可用语言和为文本索引指定语言。默认值为english。
language_override	串	可选的。对于文本索引，是集合文档中包含文档替代语言的字段名称。默认值为language。有关示例，请参见 使用任何字段指定文档的语言。
textIndexVersion	整数	可选的。该text指数的版本号。用户可以使用此选项覆盖默认版本号。 有关可用版本，请参见“ 版本”。
2dsphereIndexVersion	整数	可选的。该2dsphere指数的版本号。用户可以使用此选项覆盖默认版本号。 有关可用版本，请参见版本。
bits	整数	可选的。对于2d索引，位置数据的存储geohash值的精度数。 的bits取值范围为1至32以下。默认值为26。
min	数	可选的。对于2d索引，经度和纬度值的下界边界。默认值为-180.0。
max	数	可选的。对于2d索引，是经度和纬度值的包含上边界。默认值为180.0。
bucketSize	数	对于geoHaystack索引，请指定用于对位置值进行分组的单位数；也就是说，在同一存储桶中将彼此在指定数量单位内的位置值分组。 该值必须大于0。
collation	文献	可选的。指定索引的排序规则。 归类允许用户为字符串比较指定特定于语言的规则，例如字母大写和重音符号的规则。 如果您在集合级别指定了排序规则，则： 如果在创建索引时未指定排序规则，则MongoDB将使用集合的默认排序规则创建索引。 如果在创建索引时确实指定了排序规则，则MongoDB会使用指定的排序规则创建索引。 排序规则选项具有以下语法： 复制 collation: { locale: <string>, caseLevel: <boolean>, caseFirst: <string>, strength: <int>, numericOrdering: <boolean>, alternate: <string>, maxVariable: <string>, backwards: <boolean> } 指定排序规则时，该locale字段为必填字段；所有其他排序规则字段都是可选的。有关字段的说明，请参见整理文档。 3.4版的新功能。
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 } } 除了显式包含 _id字段外，您无法在wildcardProjection文档中组合包含和排除语句 。

所述mongo外壳提供了方法 db.collection.createIndex()和 db.collection.createIndexes()作为包装的 createIndexes命令。

注意事项¶

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

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

行为¶

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

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

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

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

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

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

例子¶

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

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