通配符索引
在本页面
MongoDB支持在一个或一组字段上创建索引,以支持查询。由于MongoDB支持动态模式,应用程序可以查询不能提前知道名称或任意名称的字段。
MongoDB版本中的新功能: 4.2
MongoDB 4.2引入了通配符索引,以支持针对未知或任意字段的查询。
考虑一个应用程序,该应用程序在该
userMetadata
字段下捕获用户定义的数据 并支持查询该数据:{ "userMetadata" : { "likes" : [ "dogs", "cats" ] } }
{ "userMetadata" : { "dislikes" : "pickles" } }
{ "userMetadata" : { "age" : 45 } }
{ "userMetadata" : "inactive" }
管理员希望创建索引来支持对
userMetadata
的任何子字段的查询。在通配符索引
userMetadata
可以支持单场查询userMetadata
, userMetadata.likes
,userMetadata.dislikes
,和 userMetadata.age
:db.userData.createIndex( { "userMetadata.$**" : 1 } )
该索引可以支持以下查询:
db.userData.find({ "userMetadata.likes" : "dogs" })
db.userData.find({ "userMetadata.dislikes" : "pickles" })
db.userData.find({ "userMetadata.age" : { $gt : 30 } })
db.userData.find({ "userMetadata" : "inactive" })
userMetadata
上的非通配符索引只能支持对userMetadata
的查询。[warning] 重要
索引特定字段的值:
db.collection.createIndex( { "fieldA.$**" : 1 } )
使用这个通配符索引,MongoDB将索引
fieldA
的所有值。如果字段是嵌套的文档或数组,通配符索引将递归到文档/数组中,并存储文档/数组中所有字段的值。例如,
product_catalog
集合中的文档可能包含product_attributes
字段。product_attributes
字段可以包含任意嵌套的字段,包括嵌入的文档和数组:{
"product_name" : "Spy Coat",
"product_attributes" : {
"material" : [ "Tweed", "Wool", "Leather" ]
"size" : {
"length" : 72,
"units" : "inches"
}
}
}
{
"product_name" : "Spy Pen",
"product_attributes" : {
"colors" : [ "Blue", "Black" ],
"secret_feature" : {
"name" : "laser",
"power" : "1000",
"units" : "watts",
}
}
}
下面的操作在
product_attributes
字段上创建一个通配符索引:db.products_catalog.createIndex( { "product_attributes.$**" : 1 } )
通配符索引可以支持对
product_attributes
或其内嵌字段的任意单字段查询:db.products_catalog.find( { "product_attributes.size.length" : { $gt : 60 } } )
db.products_catalog.find( { "product_attributes.material" : "Leather" } )
db.products_catalog.find( { "product_attributes.secret_feature.name" : "laser" } )
[success] 注意
要索引文档中所有字段的值(不包括
_id
),指定“$**”
作为索引键:db.collection.createIndex( { "$**" : 1 } )
使用这个通配符索引,MongoDB为集合中每个文档的所有字段建立索引。如果给定字段是嵌套的文档或数组,通配符索引将递归到文档/数组中,并存储文档/数组中所有字段的值。
[success] 注意
索引一个文档中多个特定字段的值:
db.collection.createIndex(
{ "$**" : 1 },
{ "wildcardProjection" :
{ "fieldA" : 1, "fieldB.fieldC" : 1 }
}
)
使用这个通配符索引,MongoDB为集合中每个文档的指定字段的所有值建立索引。如果给定字段是嵌套的文档或数组,通配符索引将递归到文档/数组中,并存储文档/数组中所有字段的值。
[success] 注意
要为文档中除特定字段路径之外的所有字段的字段建立索引,请执行以下操作 :
db.collection.createIndex(
{ "$**" : 1 },
{ "wildcardProjection" :
{ "fieldA" : 0, "fieldB.fieldC" : 0 }
}
)
使用这个通配符索引,MongoDB为集合中每个文档的所有字段建立索引,不包括指定的字段路径。如果给定字段是嵌套的文档或数组,通配符索引将递归到文档/数组中,并存储文档/数组中所有字段的值。
[success] 注意
- 通配符索引默认情况下省略
_id
字段。要在通配符索引中包含_id
字段,必须显式地将其包含在wildcardProjection文档中(即**{“_id”:1}**)。 - 您可以在一个集合中创建多个通配符索引。
- 通配符索引可能与集合中的其他索引覆盖相同的字段。
通配符索引在索引对象(例如嵌入的文档)或数组字段时有特定的行为:
- 如果该字段是对象,则通配符索引会下降到该对象中并为其内容建立索引。通配符索引继续下降到它遇到的任何其他嵌入式文档中。
- 如果该字段是一个数组,则通配符索引将遍历该数组并索引每个元素:
- 如果数组中的元素是对象,则通配符索引会下降到该对象中以如上所述索引其内容。
- 如果该元素是一个数组--也就是说,其被直接嵌入父阵列内的阵列-然后通配符指数并不能遍历嵌入式阵列,但索引的整个阵列作为一个单一的值。
- 对于所有其他字段,将原始(非对象/数组)值记录到索引中。
通配符索引将继续遍历任何其他嵌套对象或数组,直到达到原始值(即不是对象或数组的字段)为止。然后,它将索引此原始值以及该字段的完整路径。
例如,考虑以下文档:
{
"parentField" : {
"nestedField" : "nestedValue",
"nestedObject" : {
"deeplyNestedField" : "deeplyNestedValue"
},
"nestedArray" : [
"nestedArrayElementOne",
[ "nestedArrayElementTwo" ]
]
}
}
包含
parentField
的通配符索引记录了以下条目:"parentField.nestedField" : "nestedValue"
"parentField.nestedObject.deeplyNestedField" : "deeplyNestedValue"
"parentField.nestedArray" : "nestedArrayElementOne"
"parentField.nestedArray" : ["nestedArrayElementTwo"]
注意,记录
parentField.nestedArray
不包含每个元素的数组位置。当将元素记录到索引中时,通配符索引会忽略数组元素的位置。通配符索引仍然可以支持包含显式数组索引的查询。有关更多信息,请参见具有显式数组索引的查询。当通配符索引遇到嵌套对象时,它下降到该对象并对其内容进行索引。例如:
{
"parentField" : {
"nestedField" : "nestedValue",
"nestedArray" : ["nestedElement"]
"nestedObject" : {
"deeplyNestedField" : "deeplyNestedValue"
}
}
}
包含
parentField
的通配符索引向下遍历对象并索引其内容:- 对于本身就是对象(即嵌入式文档)的每个字段,请进入该对象以为其内容编制索引。
- 对于每个是数组的字段,遍历该数组并为其内容建立索引。
- 对于所有其他字段,将原始(非对象/数组)值记录到索引中。
通配符索引继续遍历任何附加的嵌套对象或数组,直到它到达一个基本值(即一个不是对象或数组的字段)。然后,它为这个原始值以及该字段的完整路径建立索引。
给定样本文档,通配符索引将以下记录添加到索引中:
"parentField.nestedField" : "nestedValue"
"parentField.nestedObject.deeplyNestedField" : "deeplyNestedValue"
"parentField.nestedArray" : "nestedElement"
当通配符索引遇到嵌套数组时,它尝试遍历该数组以索引其元素。如果数组本身是父数组(即嵌入式数组)中的一个元素,通配符索引会将整个数组记录为一个值,而不是遍历其内容。例如:
{
"parentArray" : [
"arrayElementOne",
[ "embeddedArrayElement" ],
"nestedObject" : {
"nestedArray" : [
"nestedArrayElementOne",
"nestedArrayElementTwo"
]
}
]
}
包含
parentArray
的通配符索引向下到数组中遍历和索引它的内容:- 对于作为数组(即嵌入式数组)的每个元素,将_整个_数组索引为一个值。
- 对于作为对象的每个元素,请进入该对象以遍历并为其内容编制索引。
- 对于所有其他字段,将原始(非对象/数组)值记录到索引中。
通配符索引继续遍历任何附加的嵌套对象或数组,直到它到达一个基本值(即一个不是对象或数组的字段)。然后,它为这个原始值以及该字段的完整路径建立索引。
给定样本文档,通配符索引将以下记录添加到索引中:
"parentArray" : "arrayElementOne"
"parentArray" : ["embeddedArrayElement"]
"parentArray.nestedObject.nestedArray" : "nestedArrayElementOne"
"parentArray.nestedObject.nestedArray" : "nestedArrayElementTwo"
注意,记录
parentField.nestedArray
不包含每个元素的数组位置。当将元素记录到索引中时,通配符索引会忽略数组元素的位置。通配符索引仍然可以支持包含显式数组索引的查询。有关更多信息,请参见 具有显式数组索引的查询。