MongoDB admite la creación de índices en un campo o conjunto de campos para admitir consultas. Dado que MongoDB admite esquemas dinámicos, las aplicaciones pueden consultar campos cuyos nombres no se pueden conocer de antemano o son arbitrarios.
Nuevo en la versión MongoDB : 4.2
MongoDB 4.2 introduce índices comodín para admitir consultas en campos desconocidos o arbitrarios.
Considere una aplicación que captura datos definidos por el usuario debajo del userMetadatacampo y admite consultas contra esos datos:
{ "userMetadata" : { "likes" : [ "dogs", "cats" ] } }{ "userMetadata" : { "dislikes" : "pickles" } }{ "userMetadata" : { "age" : 45 } }{ "userMetadata" : "inactive" }
Los administradores quieren crear índices para admitir consultas en cualquier subcampo de userMetadata.
Un índice de comodín en userMetadata admita consultas de un solo campo en userMetadata, userMetadata.likes, userMetadata.dislikes, y userMetadata.age:
db.userData.createIndex( { "userMetadata.$**" : 1 } )
El índice puede admitir las siguientes consultas:
db.userData.find({ "userMetadata.likes" : "dogs" })db.userData.find({ "userMetadata.dislikes" : "pickles" })db.userData.find({ "userMetadata.age" : { $gt : 30 } })db.userData.find({ "userMetadata" : "inactive" })
Un índice que no sea comodín userMetadatasolo puede admitir consultas sobre valores de userMetadata.IMPORTANTE
Los índices comodín no están diseñados para reemplazar la planificación de índices basada en cargas de trabajo. Para obtener más información sobre cómo crear índices para respaldar consultas, consulte Crear índices para respaldar sus consultas . Para obtener documentación completa sobre las limitaciones del índice de comodines, consulte Restricciones del índice de comodines .
IMPORTANTE
El featureCompatibilityVersion debe ser para crear índices comodín. Para obtener instrucciones sobre cómo configurar la fCV, consulte Establecer versión de compatibilidad de funciones en implementaciones de MongoDB 4.4 .mongod 4.2
Puede crear índices comodín utilizando el createIndexescomando de la base de datos o sus ayudantes de shell, createIndex()o createIndexes().
Para indexar el valor de un campo específico:
db.collection.createIndex( { "fieldA.$**" : 1 } )
Con este índice comodín, MongoDB indexa todos los valores de fieldA. Si el campo es un documento o una matriz anidados, el índice comodín se repite en el documento o la matriz y almacena el valor de todos los campos en el documento o la matriz.
Por ejemplo, los documentos de la product_catalogcolección pueden contener un product_attributescampo. El product_attributescampo puede contener campos anidados arbitrarios, incluidos documentos y matrices incrustados:
{ "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", } }}
La siguiente operación crea un índice comodín en el product_attributescampo:
db.products_catalog.createIndex( { "product_attributes.$**" : 1 } )
El índice comodín puede admitir consultas arbitrarias de un solo campo en product_attributessus campos integrados:
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" } )
NOTA
La sintaxis del índice comodín específico de la ruta es incompatible con la wildcardProjectionopción. Consulte las Opciones de wildcardíndices para obtener más información.
Para ver un ejemplo, consulte Crear un índice comodín en una ruta de un solo campo .
Para indexar el valor de todos los campos en un documento (excluyendo _id), especifique "$**"como clave de índice:
db.collection.createIndex( { "$**" : 1 } )
Con este índice comodín, MongoDB indexa todos los campos de cada documento de la colección. Si un campo determinado es un documento o una matriz anidados, el índice comodín se repite en el documento / matriz y almacena el valor de todos los campos en el documento / matriz.
Para ver un ejemplo, consulte Crear un índice comodín en todas las rutas de campo .NOTA
Los índices comodín omiten el _idcampo de forma predeterminada. Para incluir el _idcampo en el índice comodín, debe incluirlo explícitamente en el wildcardProjectiondocumento. Consulte Opciones de wildcardíndices para obtener más información.
Para indexar los valores de varios campos específicos en un documento:
db.collection.createIndex( { "$**" : 1 }, { "wildcardProjection" : { "fieldA" : 1, "fieldB.fieldC" : 1 } })
Con este índice comodín, MongoDB indexa todos los valores de los campos especificados para cada documento de la colección. Si un campo determinado es un documento o una matriz anidados, el índice comodín se repite en el documento / matriz y almacena el valor de todos los campos en el documento / matriz.NOTA
Los índices comodín no admiten la combinación de declaraciones de inclusión y exclusión en el wildcardProjectiondocumento, excepto cuando se incluye explícitamente el _idcampo. Para obtener más información sobre wildcardProjection, consulte Opciones para wildcardíndices .
Para obtener un ejemplo, consulte Incluir campos específicos en la cobertura del índice comodín .
Para indexar los campos de todos los campos en un documento excluyendo rutas de campo específicas:
db.collection.createIndex( { "$**" : 1 }, { "wildcardProjection" : { "fieldA" : 0, "fieldB.fieldC" : 0 } })
Con este índice comodín, MongoDB indexa todos los campos de cada documento de la colección, excluyendo las rutas de campo especificadas. Si un campo determinado es un documento o una matriz anidados, el índice comodín se repite en el documento / matriz y almacena los valores de todos los campos en el documento / matriz.
Para obtener un ejemplo, consulte Omitir campos específicos de la cobertura del índice comodín .NOTA
Los índices comodín no admiten la combinación de declaraciones de inclusión y exclusión en el wildcardProjectiondocumento, excepto cuando se incluye explícitamente el _idcampo. Para obtener más información sobre wildcardProjection, consulte Opciones para wildcardíndices .
- Los índices comodín pueden admitir como máximo un campo en cualquier predicado de consulta determinado. Para obtener más información sobre la compatibilidad con consultas de índice comodín, consulte Compatibilidad con consultas / clasificación de índice comodín .
- El featureCompatibilityVersion debe ser para crear índices comodín. Para obtener instrucciones sobre cómo configurar la fCV, consulte Establecer versión de compatibilidad de funciones en implementaciones de MongoDB 4.4 .
mongod4.2 - Los índices comodín omiten el campo _id de forma predeterminada. Para incluir el
_idcampo en el índice comodín, debe incluirlo explícitamente en el documento wildcardProjection (es decir{ "_id" : 1 }). - Puede crear varios índices comodín en una colección.
- Un índice comodín puede cubrir los mismos campos que otros índices de la colección.
- Los índices comodín son índices dispersos y solo contienen entradas para documentos que tienen el campo indexado, incluso si el campo de índice contiene un valor nulo.
Los índices comodín tienen un comportamiento específico al indexar campos que son un objeto (es decir, un documento incrustado) o una matriz:
- Si el campo es un objeto, el índice comodín desciende al objeto e indexa su contenido. El índice de comodines continúa descendiendo a los documentos incrustados adicionales que encuentra.
- Si el campo es una matriz, el índice comodín atraviesa la matriz e indexa cada elemento:
- Si un elemento de la matriz es un objeto, el índice comodín desciende al objeto para indexar su contenido como se describe anteriormente.
- Si el elemento es una matriz, es decir, una matriz que está incrustada directamente dentro de la matriz principal, entonces el índice comodín no atraviesa la matriz incrustada, sino que indexa toda la matriz como un valor único.
- Para todos los demás campos, registre el valor primitivo (no objeto / matriz) en el índice.
El índice comodín continúa atravesando cualquier objeto o arreglo adicional anidado hasta que alcanza un valor primitivo (es decir, un campo que no es un objeto o arreglo). Luego indexa este valor primitivo, junto con la ruta completa a ese campo.
Por ejemplo, considere el siguiente documento:
{ "parentField" : { "nestedField" : "nestedValue", "nestedObject" : { "deeplyNestedField" : "deeplyNestedValue" }, "nestedArray" : [ "nestedArrayElementOne", [ "nestedArrayElementTwo" ] ] }}
Un índice comodín que incluye parentFieldregistros de las siguientes entradas:
"parentField.nestedField" : "nestedValue""parentField.nestedObject.deeplyNestedField" : "deeplyNestedValue""parentField.nestedArray" : "nestedArrayElementOne""parentField.nestedArray" : ["nestedArrayElementTwo"]
Tenga en cuenta que los registros de parentField.nestedArrayno incluyen la posición de la matriz para cada elemento. Los índices comodín ignoran las posiciones de los elementos de la matriz al registrar el elemento en el índice. Los índices comodín aún pueden admitir consultas que incluyen índices de matriz explícitos. Consulte Consultas con índices de matriz explícitos para obtener más información.
Para obtener más información sobre el comportamiento del índice comodín con objetos anidados, consulte Objetos anidados .
Para obtener más información sobre el comportamiento del índice comodín con matrices anidadas, consulte Matrices anidadas .
Cuando un índice comodín encuentra un objeto anidado, desciende al objeto e indexa su contenido. Por ejemplo:
{ "parentField" : { "nestedField" : "nestedValue", "nestedArray" : ["nestedElement"] "nestedObject" : { "deeplyNestedField" : "deeplyNestedValue" } }}
Un índice comodín que incluye parentFielddesciende al objeto para recorrer e indexar su contenido:
- Para cada campo que sea en sí mismo un objeto (es decir, un documento incrustado), descienda al objeto para indexar su contenido.
- Para cada campo que sea una matriz, recorra la matriz e indexe su contenido.
- Para todos los demás campos, registre el valor primitivo (no objeto / matriz) en el índice.
El índice comodín continúa atravesando cualquier objeto o arreglo adicional anidado hasta que alcanza un valor primitivo (es decir, un campo que no es un objeto o arreglo). Luego indexa este valor primitivo, junto con la ruta completa a ese campo.
Dado el documento de muestra, el índice comodín agrega los siguientes registros al índice:
"parentField.nestedField" : "nestedValue""parentField.nestedObject.deeplyNestedField" : "deeplyNestedValue""parentField.nestedArray" : "nestedElement"
Para obtener más información sobre el comportamiento del índice comodín con matrices anidadas, consulte Matrices anidadas .
Cuando un índice comodín encuentra una matriz anidada, intenta atravesar la matriz para indexar sus elementos. Si la matriz es en sí misma un elemento de una matriz principal (es decir, una matriz incrustada), el índice comodín registra la matriz completa como un valor en lugar de atravesar su contenido. Por ejemplo:
{ "parentArray" : [ "arrayElementOne", [ "embeddedArrayElement" ], "nestedObject" : { "nestedArray" : [ "nestedArrayElementOne", "nestedArrayElementTwo" ] } ]}
Un índice comodín que incluye parentArraydesciende a la matriz para recorrer e indexar su contenido:
- Para cada elemento que sea una matriz (es decir, una matriz incrustada), indexe la matriz completa como un valor.
- Para cada elemento que sea un objeto, descienda al objeto para recorrer e indexar su contenido.
- Para todos los demás campos, registre el valor primitivo (no objeto / matriz) en el índice.
El índice comodín continúa atravesando cualquier objeto o arreglo adicional anidado hasta que alcanza un valor primitivo (es decir, un campo que no es un objeto o arreglo). Luego indexa este valor primitivo, junto con la ruta completa a ese campo.
Dado el documento de muestra, el índice comodín agrega los siguientes registros al índice:
"parentArray" : "arrayElementOne""parentArray" : ["embeddedArrayElement"]"parentArray.nestedObject.nestedArray" : "nestedArrayElementOne""parentArray.nestedObject.nestedArray" : "nestedArrayElementTwo"
Tenga en cuenta que los registros de parentField.nestedArrayno incluyen la posición de la matriz para cada elemento. Los índices comodín ignoran las posiciones de los elementos de la matriz al registrar el elemento en el índice. Los índices comodín aún pueden admitir consultas que incluyen índices de matriz explícitos. Consulte Consultas con índices de matriz explícitos para obtener más información.CONSEJOVer también:
Nested Depth for BSON Documents
- No puede fragmentar una colección mediante un índice comodín. Cree un índice que no sea comodín en el campo o los campos en los que desea fragmentar. Para obtener más información sobre la selección de claves de fragmentos, consulte Claves de fragmentos .
- No puede crear un índice compuesto .
- No puede especificar las siguientes propiedades para un índice comodín:
- No puede crear los siguientes tipos de índices utilizando la sintaxis de comodines:
IMPORTANTE
Los índices comodín son distintos e incompatibles con los índices de texto comodín . Los índices comodín no pueden admitir consultas mediante el $textoperador.
Para obtener documentación completa sobre las restricciones de creación de índices comodín, consulte Propiedades o tipos de índices incompatibles .
Los índices comodín pueden admitir una consulta cubierta solo si se cumplen todas las condiciones siguientes:
- El planificador de consultas selecciona el índice comodín para satisfacer el predicado de la consulta.
- El predicado de la consulta especifica exactamente un campo cubierto por el índice comodín.
- La proyección excluye
_ide incluye explícitamente solo el campo de consulta. - El campo de consulta especificado nunca es una matriz.
Considere el siguiente índice comodín en la employeescolección:
db.products.createIndex( { "$**" : 1 } )
La siguiente operación consulta para un solo campo lastNamey proyecta todos los demás campos del documento resultante:
db.products.find( { "lastName" : "Doe" }, { "_id" : 0, "lastName" : 1 })
Suponiendo que lo especificado lastNamenunca es una matriz, MongoDB puede usar el $**índice comodín para admitir una consulta cubierta.
Los índices comodín pueden admitir como máximo un campo de predicado de consulta. Es decir:
- MongoDB no puede utilizar un índice que no sea comodín para satisfacer una parte de un predicado de consulta y un índice comodín para satisfacer otra.
- MongoDB no puede usar un índice comodín para satisfacer una parte de un predicado de consulta y otro índice comodín para satisfacer otro.
- Incluso si un único índice comodín pudiera admitir varios campos de consulta, MongoDB puede usar el índice comodín para admitir solo uno de los campos de consulta. Todos los campos restantes se resuelven sin índice.
Sin embargo, MongoDB puede usar el mismo índice comodín para satisfacer cada argumento independiente de los operadores de consulta $oro agregación $or.
MongoDB puede usar un índice comodín para satisfacer el solo si todo lo siguiente es verdadero:sort()
- El planificador de consultas selecciona el índice comodín para satisfacer el predicado de la consulta.
- Las
sort()especifica solamente el campo de consulta predicado. - El campo especificado nunca es una matriz.
Si no se cumplen las condiciones anteriores, MongoDB no puede usar el índice comodín para la ordenación. MongoDB no admite sort() operaciones que requieran un índice diferente al del predicado de consulta. Para obtener más información, consulte Intersección y ordenación de índices .
Considere el siguiente índice comodín en la productscolección:
db.products.createIndex( { "product_attributes.$**" : 1 } )
La siguiente operación consulta para un solo campo product_attributes.pricey ordena en ese mismo campo:
db.products.find( { "product_attributes.price" : { $gt : 10.00 } },).sort( { "product_attributes.price" : 1 })
Suponiendo que lo especificado pricenunca es una matriz, MongoDB puede usar el product_attributes.$**índice comodín para satisfacer tanto el find()y sort().
- Los índices comodín no pueden admitir la condición de consulta que comprueba si un campo no existe.
- Los índices comodín no pueden admitir la condición de consulta que comprueba si un campo es o no igual a un documento o una matriz.
- Los índices comodín no pueden admitir la condición de consulta que comprueba si un campo no es igual a nulo.
Para obtener más información, consulte Patrones de consulta y agregación no admitidos .
Los índices comodín de MongoDB no registran la posición de la matriz de ningún elemento dado en una matriz durante la indexación. Sin embargo, MongoDB aún puede seleccionar el índice comodín para responder a una consulta que incluye una ruta de campo con uno o más índices de matriz explícitos (por ejemplo, parentArray.0.nestedArray.0). Debido a la creciente complejidad de definir límites de índice para cada matriz anidada consecutiva, MongoDB no considera que el índice comodín responda a una ruta de campo determinada en la consulta si esa ruta contiene más que 8índices de matriz explícitos. MongoDB aún puede considerar el índice comodín para responder a otras rutas de campo en la consulta.
Por ejemplo:
{ "parentObject" : { "nestedArray" : [ "elementOne", { "deeplyNestedArray" : [ "elementTwo" ] } ] }}
MongoDB puede seleccionar un índice comodín que incluye parentObjectsatisfacer las siguientes consultas:
"parentObject.nestedArray.0" : "elementOne""parentObject.nestedArray.1.deeplyNestedArray.0" : "elementTwo"
Si una ruta de campo determinada en el predicado de consulta especifica más de 8 índices de matriz explícitos, MongoDB no considera el índice comodín para responder a esa ruta de campo. En cambio, MongoDB selecciona otro índice elegible para responder a la consulta o realiza un análisis de la colección.
Tenga en cuenta que los índices comodín en sí mismos no tienen ningún límite en la profundidad a la que atraviesan un documento mientras lo indexan; la limitación solo se aplica a consultas que especifican explícitamente índices de matriz exactos. Al emitir las mismas consultas sin los índices de matriz explícitos, MongoDB puede seleccionar el índice comodín para responder a la consulta:
"parentObject.nestedArray" : "elementOne""parentObject.nestedArray.deeplyNestedArray" : "elementTwo"
CONSEJOVer también: