通配符索引

在字段上创建通配符索引¶

索引特定字段的值：

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

有关示例，请参见在单字段路径上创建通配符索引。

在所有字段上创建通配符索引¶

要索引文档中所有字段的值（不包括_id），请指定"$**"为索引键：

db.collection.createIndex( { "$**" : 1 } )

使用此通配符索引，MongoDB可以为集合中每个文档的所有字段建立索引。如果给定字段是嵌套文档或数组，则通配符索引将递归到文档/数组中，并将所有字段的值存储在文档/数组中。

有关示例，请参见在所有字段路径上创建通配符索引。

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

要索引文档中多个特定字段的值：

db.collection.createIndex(
  { "$**" : 1 },
  { "wildcardProjection" :
    { "fieldA" : 1, "fieldB.fieldC" : 1 }
  }
)

使用此通配符索引，MongoDB可以为集合中每个文档的指定字段索引所有值。如果给定字段是嵌套文档或数组，则通配符索引将递归到文档/数组中，并将所有字段的值存储在文档/数组中。

有关示例，请参阅在通配符索引覆盖范围中包括特定字段。

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

若要索引文档中除特定字段路径之外的所有字段的 字段：

db.collection.createIndex(
  { "$**" : 1 },
  { "wildcardProjection" :
    { "fieldA" : 0, "fieldB.fieldC" : 0 }
  }
)

使用此通配符索引，MongoDB会为集合中每个文档的所有字段建立索引，但不包括指定的字段路径。如果给定字段是嵌套文档或数组，则通配符索引将递归到文档/数组中，并将所有字段的值存储在文档/数组中。

有关示例，请参见从通配符索引覆盖率中忽略特定字段。

嵌套对象¶

当通配符索引遇到嵌套对象时，它会下降到该对象中并为其内容编制索引。例如：

{
  "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不包括每个元素的数组位置。将元素记录到索引中时，通配符索引会忽略数组元素的位置。通配符索引仍然可以支持包含显式数组索引的查询。有关更多信息，请参见 具有显式数组索引的查询。

覆盖查询¶

仅当满足以下所有条件时，通配符索引才能支持覆盖的查询 ：

• 查询计划者选择通配符索引以满足查询谓词。
• 查询谓词恰好指定了通配符索引覆盖的一个字段。
• 该投影显式排除_id并仅包括查询字段。
• 指定的查询字段永远不会是数组。

考虑employees集合上的以下通配符索引：

db.products.createIndex( { "$**" : 1 } )

以下操作查询单个字段， lastName并从结果文档中投影出所有其他字段：

db.products.find(
  { "lastName" : "Doe" },
  { "_id" : 0, "lastName" : 1 }
)

假设指定的lastName对象永远不是数组，MongoDB可以使用$**通配符索引来支持覆盖查询。

多字段查询谓词¶

通配符索引最多可以支持一个查询谓词字段。那是：

• MongoDB无法使用非通配符索引来满足查询谓词的一部分，而不能使用通配符索引来满足另一部分。
• MongoDB无法使用一个通配符索引来满足查询谓词的一部分，而使用另一个通配符索引来满足另一部分。
• 即使单个通配符索引可以支持多个查询字段，MongoDB也可以使用通配符索引来仅支持其中一个查询字段。其余所有字段都将解析而没有索引。

但是，MongoDB可以使用相同的通配符索引来满足查询$or或聚合 $or运算符的每个独立参数。

与排序查询¶

如果满足以下所有条件，则MongoDB可以使用通配符索引来满足 唯一条件：sort()

• 查询计划者选择通配符索引以满足查询谓词。
• 该sort()指定唯一的查询谓词场。
• 指定的字段永远不会是数组。

如果不满足上述条件，则MongoDB无法使用通配符索引进行排序。MongoDB不支持sort 需要与查询谓词不同的索引的操作。有关更多信息，请参见索引交集和排序。

考虑products集合上的以下通配符索引：

db.products.createIndex( { "product_attributes.$**" : 1 } )

以下操作查询单个字段 product_attributes.price并在同一字段上排序：

db.products.find(
  { "product_attributes.price" : { $gt : 10.00 } },
).sort(
  { "product_attributes.price" : 1 }
)

假设指定的price对象永远不是数组，MongoDB可以使用product_attributes.$**通配符索引来满足find()和sort()。

不支持的查询模式¶

• 通配符索引不能支持查询条件，该条件检查字段是否不存在。
• 通配符索引不支持查询条件，该条件检查字段是否等于文档或数组
• 通配符索引不能支持查询条件，该条件检查字段是否不等于null。

有关详细信息，请参阅不支持的查询和聚合模式。

用明确的数组索引查询¶

MongoDB通配符索引不会在索引期间记录数组中任何给定元素的数组位置。但是，MongoDB仍然可以选择通配符索引来回答包含具有一个或多个显式数组索引（例如parentArray.0.nestedArray.0）的字段路径的查询 。由于为每个连续的嵌套数组定义索引范围的复杂性越来越高，因此，如果该路径包含的8显式数组索引多，则MongoDB不会考虑使用通配符索引来回答查询中的给定字段路径。MongoDB仍然可以考虑使用通配符索引来回答查询中的其他字段路径。

例如：

{
  "parentObject" : {
    "nestedArray" : [
       "elementOne",
       {
         "deeplyNestedArray" : [ "elementTwo" ]
       }
     ]
  }
}

MongoDB可以选择一个包含parentObject以下查询的通配符索引：

• "parentObject.nestedArray.0" : "elementOne"
• "parentObject.nestedArray.1.deeplyNestedArray.0" : "elementTwo"

如果查询谓词中的给定字段路径指定了8个以上的显式数组索引，则MongoDB不会考虑通配符索引来回答该字段路径。相反，MongoDB要么选择另一个符合条件的索引来回答查询，要么执行集合扫描。

请注意，通配符索引本身对索引时遍历文档的深度没有任何限制；该限制仅适用于明确指定确切数组索引的查询。通过发出没有显式数组索引的相同查询，MongoDB可以选择通配符索引来回答该查询：

• "parentObject.nestedArray" : "elementOne"
• "parentObject.nestedArray.deeplyNestedArray" : "elementTwo"