索引

查询覆盖率和性能

当您对MongoDB执行查询时，您的命令可以包含各种元素

• 查询条件，指定您要查找的字段和值

• 选项，影响查询的执行，如读取关注点

• 投影条件，指定MongoDB返回的字段（可选）

• 排序条件，指定从MongoDB返回的文档的顺序（可选）

当查询、投影和排序中指定的所有字段都在同一个索引中时，MongoDB可以直接从索引返回结果，也称为覆盖查询。

name_1_age_-1

有关如何确保您的索引覆盖查询条件和投影的更多信息，请参阅服务器手册中的查询覆盖文章。

操作注意事项

以下指南描述了如何优化应用程序使用索引的方式

• 为了提高查询性能，在经常出现在应用程序查询和返回排序结果的字段上建立索引。

• 跟踪索引内存和磁盘使用情况，以便进行容量规划，因为每个索引在活动状态下都会消耗磁盘空间和内存。

• 避免添加不常使用的索引。请注意，当写操作更新索引字段时，MongoDB会更新相关的索引。

由于MongoDB支持动态模式，应用程序可以查询那些名称无法提前知道或任意的字段。MongoDB 4.2引入了通配索引以帮助支持这些查询。通配索引并不是为了替换基于工作负载的索引规划。

有关设计数据模型和选择适合应用程序的索引的更多信息，请参阅MongoDB服务器文档中的索引策略和数据建模和索引。

单字段和组合索引

val resultCreateIndex = moviesCollection.createIndex(Indexes.ascending(Movie::title.name))
println("Index created: $resultCreateIndex")

Index created: title_1

val filter = Filters.eq(Movie::title.name, "The Dark Knight")
val sort = Sorts.ascending(Movie::title.name)
val projection = Projections.fields(
    Projections.include(Movie::title.name),
    Projections.excludeId()
)
data class Results(val title: String)
val resultsFlow = moviesCollection.find<Results>(filter).sort(sort).projection(projection)
resultsFlow.collect { println(it) }

val resultCreateIndex = moviesCollection.createIndex(Indexes.ascending(Movie::type.name, Movie::rated.name))
println("Index created: $resultCreateIndex")

Index created: type_1_rated_1

val filter = Filters.and(
    Filters.eq(Movie::type.name, "movie"),
    Filters.eq(Movie::rated.name, "G")
)
val sort = Sorts.ascending(Movie::type.name, Movie::rated.name)
val projection = Projections.fields(
    Projections.include(Movie::type.name, Movie::rated.name),
    Projections.excludeId()
)
val resultsFlow = moviesCollection.find(filter).sort(sort).projection(projection)
resultsFlow.collect { println(it) }

多键索引（数组字段上的索引）

多键索引是一种提高指定包含数组值的索引字段的查询性能的索引。您可以使用与单个字段或组合索引相同的语法定义多键索引。

以下示例在rated、genres（字符串数组）和title字段上创建了一个组合多键索引。

val resultCreateIndex =
    moviesCollection.createIndex(Indexes.ascending(Movie::rated.name, Movie::genres.name, Movie::title.name))
println("Index created: $resultCreateIndex")

Index created: rated_1_genres_1_title_1

以下是一个查询示例，该查询由前面代码片段中创建的索引覆盖

val filter = Filters.and(
    Filters.eq(Movie::genres.name, "Animation"),
    Filters.eq(Movie::rated.name, "G")
)
val sort = Sorts.ascending(Movie::title.name)
val projection = Projections.fields(
    Projections.include(Movie::title.name, Movie::rated.name),
    Projections.excludeId()
)
val resultsFlow = moviesCollection.find(filter).sort(sort).projection(projection)
resultsFlow.collect { println(it) }

多键索引在查询覆盖、索引边界计算和排序行为方面与其他索引的行为不同。有关多键索引的更多信息，包括对其行为和限制的讨论，请参阅服务器手册中的多键索引。

Atlas 搜索和向量搜索索引

您可以使用 Kotlin 驱动程序以编程方式管理您的 Atlas 搜索和 Atlas 向量搜索索引。

Atlas 搜索功能使您能够在 MongoDB Atlas 上托管的数据集中执行全文搜索。有关 MongoDB Atlas 搜索的更多信息，请参阅Atlas 搜索索引文档。

Atlas 向量搜索使您能够对存储在 MongoDB Atlas 中的向量嵌入执行语义搜索。有关 Atlas 向量搜索的更多信息，请参阅聚合构建器指南中的 Atlas 向量搜索部分。

您可以在集合上调用以下方法来管理您的 Atlas 搜索和向量搜索索引

• createSearchIndex() （仅适用于搜索索引）

• createSearchIndexes()

• listSearchIndexes()

• updateSearchIndex()

• dropSearchIndex()

以下各节提供了代码示例，演示了如何使用上述每种方法。

val searchIdx = Document(
    "mappings",
    Document("dynamic", true)
)
val resultCreateIndex = moviesCollection.createSearchIndex("myIndex", searchIdx)

val searchIdxMdl = SearchIndexModel(
    "searchIdx",
    Document("analyzer", "lucene.standard").append(
        "mappings", Document("dynamic", true)
    ),
    SearchIndexType.search()
)
val vectorSearchIdxMdl = SearchIndexModel(
    "vsIdx",
    Document(
        "fields",
        listOf(
            Document("type", "vector")
                .append("path", "embeddings")
                .append("numDimensions", 1536)
                .append("similarity", "dotProduct")
        )
    ),
    SearchIndexType.vectorSearch()
)
val resultCreateIndexes = moviesCollection.createSearchIndexes(
    listOf(searchIdxMdl, vectorSearchIdxMdl)
)

val searchIndexesList = moviesCollection.listSearchIndexes().toList()

moviesCollection.updateSearchIndex(
    "myIndex",
    Document("analyzer", "lucene.simple").append(
        "mappings",
        Document("dynamic", false)
            .append(
                "fields",
                Document(
                    "title",
                    Document("type", "string")
                )
            )
    )
)

moviesCollection.dropSearchIndex("myIndex");

文本索引

文本索引 支持对字符串内容进行文本搜索查询。这些索引可以包括任何值是字符串或字符串元素数组的字段。MongoDB 支持多种语言的文本搜索。您可以在创建索引时指定默认语言作为选项。

try {
    val resultCreateIndex = moviesCollection.createIndex(Indexes.text(Movie::plot.name))
    println("Index created: $resultCreateIndex")
} catch (e: MongoCommandException) {
    if (e.errorCodeName == "IndexOptionsConflict") {
        println("there's an existing text index with different options")
    }
}

Index created: plot_text

val filter = Filters.text("Batman")
val projection = Projections.fields(
    Projections.include(Movie::fullplot.name),
    Projections.excludeId()
)
data class Results(val fullplot: String)
val resultsFlow = moviesCollection.find<Results>(filter).projection(projection)
resultsFlow.collect { println(it) }

try {
    val resultCreateIndex = moviesCollection.createIndex(
        Indexes.compoundIndex(
            Indexes.text(Movie::title.name), Indexes.text(Movie::genres.name)
        )
    )
    println("Index created: $resultCreateIndex")
} catch (e: MongoCommandException) {
    if (e.errorCodeName == "IndexOptionsConflict") {
        println("there's an existing text index with different options")
    }
}

Index created: title_text_genre_text

地理空间索引

MongoDB支持使用2dsphere索引查询地理空间坐标数据。使用2dsphere索引，您可以查询包含、相交和邻近的地理空间数据。有关查询地理空间数据的更多信息，请参阅服务器手册中的地理空间查询。

要创建2dsphere索引，您必须指定一个仅包含GeoJSON对象的字段。有关此类型的更多信息，请参阅服务器手册中的GeoJSON对象。

以下示例文档中sample_mflix数据库中theaters集合中的location.geo字段是一个描述剧院坐标的GeoJSON点对象。

{
   "_id" : ObjectId("59a47286cfa9a3a73e51e75c"),
   "theaterId" : 104,
   "location" : {
      "address" : {
         "street1" : "5000 W 147th St",
         "city" : "Hawthorne",
         "state" : "CA",
         "zipcode" : "90250"
      },
      "geo" : {
         "type" : "Point",
         "coordinates" : [
            -118.36559,
            33.897167
         ]
      }
   }
}

以下示例在location.geo字段上创建一个2dsphere索引。

val resultCreateIndex = theatersCollection.createIndex(
    Indexes.geo2dsphere("${Theater::location.name}.${Theater.Location::geo.name}")
)
println("Index created: $resultCreateIndex")

Index created: location.geo_2dsphere

以下是一个示例地理空间查询，该查询受先前代码片段中创建的索引的保护。

// MongoDB Headquarters in New York, NY.
val refPoint = Point(Position(-73.98456, 40.7612))
val filter = Filters.near(
    "${Theater::location.name}.${Theater.Location::geo.name}",
    refPoint, 1000.0, 0.0
)
val resultsFlow = theatersCollection.find(filter)
resultsFlow.collect { println(it) }

MongoDB还支持用于在欧几里得平面上计算距离和用于处理MongoDB 2.2及更早版本中使用的“旧坐标对”语法的2d索引。有关更多信息，请参阅服务器手册中的地理空间查询。

唯一索引

唯一索引确保索引字段不存储重复值。默认情况下，MongoDB在创建集合时会为_id字段创建一个唯一索引。要创建唯一索引，请指定要防止重复的字段或字段组合，并将_unique选项设置为true。

以下示例在theaterId字段上创建了一个唯一、降序索引

try {
    val indexOptions = IndexOptions().unique(true)
    val resultCreateIndex = theatersCollection.createIndex(
        Indexes.descending(Theater::theaterId.name), indexOptions
    )
    println("Index created: $resultCreateIndex")
} catch (e: DuplicateKeyException) {
    println("duplicate field values encountered, couldn't create index: \t${e.message}")
}

Index created: theaterId_-1

E11000 duplicate key error index

有关更多信息，请参阅MongoDB服务器手册中的唯一索引页面。

聚集索引

聚集索引指示集合按键值存储文档。要创建聚集索引，请指定聚集索引选项，以_id字段作为键，并在创建集合时将唯一字段设置为true。

以下示例在vendors集合的_id字段上创建了一个聚集索引

val clusteredIndexOptions = ClusteredIndexOptions(Document("_id", 1), true)
val createCollectionOptions = CreateCollectionOptions().clusteredIndexOptions(clusteredIndexOptions)
database.createCollection("vendors", createCollectionOptions)

有关更多信息，请参阅MongoDB服务器手册的相关章节

• 聚集索引

• 聚集集合

使用索引规范文档删除索引

将一个index specification document传递给dropIndex()方法，以从集合中删除索引。索引规范文档是一个指定特定字段上索引类型的Bson实例。

以下代码示例从集合中删除了title字段的升序索引

moviesCollection.dropIndex(Indexes.ascending(Movie::title.name));

使用名称字段删除索引

将索引的name字段传递给dropIndex()方法，以从集合中删除索引。

如果您必须找到索引的名称，请使用listIndexes()方法查看索引中name字段的值。

以下代码示例检索并打印集合中所有的索引

val indexes = moviesCollection.listIndexes()
indexes.collect { println(it.toJson()) }

如果您在包含文本索引的集合上调用listIndex()，输出可能如下所示

{ "v": 2, "key": {"_id": 1}, "name": "_id_" }
{ "v": 2, "key": {"_fts": "text", "_ftsx": 1}, "name": "title_text", "weights": {"title": 1},
"default_language": "english", "language_override": "language", "textIndexVersion": 3 }

此输出告诉我们现有索引的名称是 "_id" 和 "title_text"。

以下代码示例从集合中删除了 "title_text" 索引

moviesCollection.dropIndex("title_text")

使用通配符字符删除索引

从 MongoDB 4.2 版本开始，您可以通过在集合上调用 dropIndexes() 方法来删除所有索引

moviesCollection.dropIndexes()

对于 MongoDB 的早期版本，将 "*" 作为参数传递给您的集合上的 dropIndex() 调用

moviesCollection.dropIndex("*")

有关本节中方法的更多信息，请参阅以下 API 文档

• dropIndex()

• dropIndexes()