db.colección.createIndex() (método de mongosh)

MongoDB con controladores

Esta página documenta una mongosh . Para ver el método equivalente en un driver de MongoDB, se debe consultar la página correspondiente al lenguaje de programación:

C#Java Sync Node.js PyMongo C C++Go Java RS Kotlin Coroutine Kotlin Sync PHP Motor Mongoid Rust Scala Swift

Definición

db.collection.createIndex(keys, options, commitQuorum): Crea índices en colecciones.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Nota

Este comando es compatible con todos los clústeres de MongoDB Atlas. Para obtener información sobre el soporte de Atlas para todos los comandos, consulte Comandos no compatibles.

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

El método createIndex() tiene la siguiente forma:

db.collection.createIndex( <keys>, <options>, <commitQuorum>)

Parámetros

El método createIndex() toma los siguientes parámetros:

Parameter	Tipo	Descripción
`keys`	Documento	Un documento que contiene pares de campo y valor, donde el campo actúa como clave del índice y el valor describe el tipo de índice para ese campo. Para un índice ascendente en un campo, especifica un valor de `1`. Para un índice descendente, especifica un valor de `-1`. Un asterisco (`*`) no es un nombre de índice válido. MongoDB admite varios tipos de índices diferentes, incluidos: text Geoespacial índices encriptados Consulta tipos de índices para obtener más información. Los índices comodín son compatibles con cargas de trabajo en las que los usuarios realizan queries sobre campos personalizados o una gran variedad de campos en una colección. Puedes crear un índice comodín en un campo específico y sus subrutas o en todos los campos de un documento. Para obtener más información, consulta índices comodín.
`options`	Documento	Opcional. Un documento que contiene un conjunto de opciones que controlan la creación del índice. Consulta Opciones para obtener más detalles.
commitQuorum	entero o cadena de texto	Opcional. El número mínimo de nodos votantes con datos de un set de réplicas que contienen datos (es decir, quórum de confirmación), incluido el primario, que debe informar de una creación de índices exitosa antes de que el primario marque el `indexes` como listo. Un nodo "votante" es cualquier nodo del set de réplicas donde `members[n].votes` es mayor que `0`. Admite los siguientes valores: `"votingMembers"` - todos los nodos votantes con datos del set de réplicas (por defecto). `"majority"` - una mayoría simple de los nodos votantes con datos del set de réplicas. `<int>` - un número específico de nodos votantes con datos del set de réplicas. `0` - Desactiva el comportamiento de votación por quórum. Los miembros inician la creación de índices simultáneamente, pero no votan ni esperan el quórum antes de completar la creación de índices. Si inicia una creación de índices con un quórum de confirmación de `0`, no podrá modificar posteriormente el quórum de confirmación usando `setIndexCommitQuorum`. Un nombre de etiqueta de un set de réplicas.

opciones

El documento options contiene un conjunto de opciones que controla la creación del índice. Los diferentes tipos de índices pueden tener opciones adicionales específicas para cada tipo.

Se pueden especificar múltiples opciones de índice en el mismo documento. Sin embargo, si se especifican varios documentos de opción, la operación db.collection.createIndex() fallará.

Se debe considerar la siguiente operación de db.collection.createIndex():

db.collection.createIndex(
  {
      "a": 1
  },
  {
      unique: true,
      sparse: true,
      expireAfterSeconds: 3600
  }
)

Si la especificación de opciones se hubiera dividido en varios documentos como este: { unique: true }, { sparse: true, expireAfterSeconds: 3600 }, la operación de creación del índice habría fallado.

Opciones para todos los tipos de índices

Las siguientes opciones están disponibles para todos los tipos de índice, a menos que se especifique lo contrario:

Parameter

Tipo

Descripción

unique

booleano

Opcional. Crea un índice único para que la colección no acepte la inserción o actualización de documentos cuyo valor de clave de índice coincida con un valor ya existente en el índice.

Especifica true para crear un índice único. El valor por defecto es false.

La opción no está disponible para índices encriptados.

name

string

Opcional. El nombre del índice. Si no se especifica, MongoDB genera un nombre de índice concatenando los nombres de los campos indexados y el orden de clasificación.

partialFilterExpression

Documento

Opcional. Si se especifica, el índice solo hace referencia a los documentos que coinciden con la expresión del filtro. Consulta Índices parciales para obtener más información.

Una expresión de filtro puede incluir:

expresiones de igualdad (es decir, field: value o con el operador $eq)
$exists: true expresión
$gt, $gte, $lt, $lte expresiones
$type expresiones
$and operador
$or operador
$in operador
$geoWithin operador
$geoIntersects operador

Puedes especificar una opción partialFilterExpression para todos los tipos de índices de MongoDB.

sparse

booleano

Opcional. Si true, el índice solo hace referencia a documentos con el campo especificado. Estos índices utilizan menos espacio, pero se comportan de manera diferente en algunas situaciones (particularmente en ordenamientos). El valor por defecto es false. Consulta índices dispersos para obtener más información.

Los siguientes tipos de índices son escasos por defecto e ignoran esta opción:

Para un índice compuesto que incluye claves de índice 2dsphere y claves de otros tipos, solo los campos de índice 2dsphere determinan si el índice hace referencia a un documento.

Los índices parciales tienen un superconjunto de la funcionalidad del índice disperso. A menos que la aplicación tenga un requisito específico, se deben usar índices parciales en lugar de índices dispersos.

expireAfterSeconds

entero

Opcional. Especifica un valor, en segundos, como tiempo de vida (TTL) para controlar cuánto tiempo MongoDB retiene los documentos en esta colección. Esta opción solo se aplica a los índices TTL. Consulta Caducar datos de colecciones configurando TTL para obtener más información.

Si utilizas índices TTL creados antes de MongoDB 5.0, o si deseas sincronizar datos creados en MongoDB 5.0 con una versión anterior a la instalación 5.0, consulta Índices configurados usando NaN para evitar problemas de configuración errónea.

El valor del índice TTL expireAfterSeconds debe estar entre 0 y 2147483647, inclusive.

ocultos

booleano

Opcional. Una bandera que determina si el índice está oculto para el planificador de queries. Un índice oculto no se evalúa como parte de la selección del plan de la query.

El valor por defecto es false.

storageEngine

Documento

Opcional. Permite a los usuarios configurar el motor de almacenamiento por índice al crear un índice.

La opción storageEngine debe tomar la siguiente forma:

storageEngine: { <storage-engine-name>: <options> }

Las opciones de configuración del motor de almacenamiento especificadas al crear índices se validan y se registran en el oplog durante la replicación para admitir conjuntos de réplicas con miembros que utilizan diferentes motores de almacenamiento.

Opción para intercalación

Parameter

Tipo

Descripción

collation

Documento

Opcional. Especifica la intercalación para el índice.

La intercalación permite a los usuarios especificar reglas propias del lenguaje para la comparación de strings, como reglas para el uso de mayúsculas y minúsculas y marcas de acento.

Si has especificado una intercalación a nivel de colección, entonces:

Si no especificas una intercalación al crear el índice, MongoDB crea el índice con la intercalación por defecto de la colección.
Si especificas una intercalación al crear el índice, MongoDB crea el índice con la intercalación especificada.

La opción de intercalación tiene la siguiente sintaxis:

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

Al especificar la intercalación, el campo locale es obligatorio; todos los demás campos de intercalación son opcionales. Para las descripciones de los campos, consulta Documento de intercalación.

Los siguientes índices solo soportan la comparación binaria simple y no soportan la intercalación:

Text indexes
2d indexes

Tip

Para crear un índice text o 2d en una colección que tenga una intercalación no simple, debe especificar explícitamente {collation: {locale: "simple"} } al crear el índice.

Uso de la intercalación y del índice

Si has especificado una intercalación a nivel de colección, entonces:

Si no especificas una intercalación al crear el índice, MongoDB crea el índice con la intercalación por defecto de la colección.
Si especificas una intercalación al crear el índice, MongoDB crea el índice con la intercalación especificada.

Tip

Al especificar una intercalación strength de 1 o 2, puedes crear un índice insensible a mayúsculas y minúsculas. El índice con una intercalación strength de 1 es insensible tanto a diacríticos como a mayúsculas.

Puedes crear múltiples índices en las mismas claves con diferentes intercalaciones. Para crear índices con el mismo patrón de clave pero diferentes intercalaciones, debes proporcionar nombres de índice únicos.

Para utilizar un índice para las comparaciones de cadenas, una operación también debe especificar la misma intercalación. Es decir, un índice con una intercalación no puede soportar una operación que realice comparaciones de strings en los campos indexados si la operación especifica una intercalación diferente.

Advertencia

Debido a que los índices configurados con intercalación utilizan claves de intercalación ICU para lograr el orden de clasificación, las claves de índice que consideran la intercalación pueden ser más grandes que las claves de índice para los índices sin intercalación.

Una colección restaurants tiene los siguientes documentos:

db.restaurants.insertMany( [
   { _id: 1, category: "café", status: "Open" },
   { _id: 2, category: "cafe", status: "open" },
   { _id: 3, category: "cafE", status: "open" }
] )

La colección restaurants tiene un índice en un campo de string category con la intercalación de la localización "fr".

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

La siguiente query, que especifica la misma intercalación que el índice, puede utilizar el índice:

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

Sin embargo, la siguiente operación de query, que por defecto utiliza el intercalador binario "simple", no puede usarse el índice:

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

Para un índice compuesto donde las claves prefijo del índice no son cadenas, arreglos ni documentos incrustados, una operación que especifique una intercalación diferente puede seguir utilizando el índice para soportar comparaciones en las claves prefijo del índice.

Por ejemplo, la colección restaurants tiene un índice compuesto en los campos numéricos score y price y el campo de string category; el índice se crea con la localización de intercalación "fr" para comparaciones de strings:

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

Las siguientes operaciones, que utilizan la intercalación binaria "simple" para las comparaciones de strings, pueden usar el índice:

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

La siguiente operación, que utiliza la intercalación binaria "simple" para las comparaciones de string en el campo category indexado, puede usar el índice para cumplir solo con la parte score: 5 de la query:

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

Para confirmar si una consulta ha utilizado un índice, ejecuta la consulta con la opción explain().

Importante

Las coincidencias con claves de documentos, incluidas las claves de documentos incrustadas, utilizan una comparación binaria simple. Esto significa que una query para una clave como "type.café" no coincidirá con la clave "type.cafe", independientemente del valor que se establezca para el parámetro strength.

Opciones para `text` Índices

Las siguientes opciones están disponibles solo para los índices de texto:

Parameter	Tipo	Descripción
`weights`	Documento	Opcional. Para los índices de texto, un documento que contiene pares de campo y peso. El peso es un número entero que tiene un rango de 1 a 99,999 y denota la importancia del campo en relación con los otros campos indexados en términos de la puntuación. Puedes especificar pesos para algunos o todos los campos indexados. Consulta Asignar pesos a los resultados de búsqueda de texto en implementaciones autogestionadas para ajustar las puntuaciones. El valor es por defecto `1`. A partir de MongoDB 5.0, la opción pesos solo está permitida para los índices de texto.
`default_language`	string	Opcional. Para los índices de texto, el lenguaje que determina la lista de palabras vacías y las reglas para el stemmer y el tokenizador. Consulta Lenguajes de búsqueda de texto en implementaciones autogestionadas para los lenguajes disponibles y Especificar el lenguaje para índices de texto en MongoDB autogestionado para más información y ejemplos. El valor por defecto es `english`.
`language_override`	string	Opcional. Para los índices de texto, el nombre del campo en los documentos de la colección que contiene el idioma de anulación para el documento. El valor es por defecto `language`. Consulte Especificar el lenguaje para los índices de texto en MongoDB autogestionado para un ejemplo.
`textIndexVersion`	entero	Opcional. El número de versión del índice `text`. Los usuarios pueden utilizar esta opción para sobrescribir el número de versión por defecto. Para las versiones disponibles, consulta Versiones del índice de texto en implementaciones autogestionadas.

Opciones para `2dsphere` Índices

La siguiente opción está disponible únicamente para índices 2dsphere:

Parameter	Tipo	Descripción
`2dsphereIndexVersion`	entero	Opcional. El número de versión del índice `2dsphere`. Los usuarios pueden utilizar esta opción para sobrescribir el número de versión por defecto. Para las versiones disponibles, consulta Índices 2dsphere.

Opciones para `2d` Índices

Las siguientes opciones están disponibles solo para los índices 2d:

Parameter	Tipo	Descripción
`bits`	entero	Opcional. Para los índices 2d, el número de cifras significativas del valor geohash almacenado de los datos de ubicación. El valor `bits` va de 1 a 32 inclusive. El valor por defecto es `26`.
`min`	Número	Opcional. Para los índices `2d`, el límite inferior inclusivo de los valores de longitud y latitud. El valor es por defecto `-180.0`.
`max`	Número	Opcional. Para los índices `2d`, el límite superior inclusivo de los valores de longitud y latitud. El valor por defecto es `180.0`.

Opciones para `wildcard` índices

Los índices comodín pueden usar la opción wildcardProjection.

Parameter

Tipo

Descripción

wildcardProjection

Documento

Opcional. Permite a los usuarios incluir o excluir rutas de campo específicas de un índice comodín.

Esta opción solo es válida cuando se crea un índice comodín en todos los campos del documento. No se puede especificar la opción wildcardProjection al crear un índice comodín en una ruta de campo específica y sus subcampos.

wildcardProjection funciona con especificaciones tales como:

{ "$**": 1 }
{ "userID":, "$**": 1 }

Sin embargo, no puedes definir un índice que incluya el mismo campo en los campos comodín y en los campos regulares (no comodín). Para definir correctamente el índice, utilice un wildcardProjection para excluir los campos duplicados del patrón comodín.

wildcardProjection no funciona con una especificación como:

 ``{ "path.to.field.$**" : 1 }``

La opción wildcardProjection tiene la siguiente forma:

wildcardProjection: {
  "path.to.field.a" : <value>,
  "path.to.field.b" : <value>
}

El <value> puede ser uno de los siguientes:

1 o true para incluir el campo en el índice comodín.
0 o false para excluir el campo del índice comodín.

Los índices comodín omiten el campo _id por defecto. Para incluir el campo _id en el índice comodín, debes incluirlo explícitamente en el documento wildcardProjection:

{
  "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
  }
}

Todas las instrucciones en el documento wildcardProjection deben ser de inclusión o de exclusión. También puede incluir el campo _id con las instrucciones de exclusión. Esta es la única excepción a la regla.

Comportamientos

Recreación de un índice existente

Si se llama a db.collection.createIndex() para un índice que ya existe, MongoDB no recrea el índice.

Opciones del índice

Opciones sin intercalación y no ocultas

Con la excepción de la opción de intercalación, si se crea un índice con un conjunto de opciones de índice y luego intenta volver a crear el mismo índice, pero con opciones de índice diferentes, MongoDB no cambiará las opciones ni volverá a crear el índice.

La opción oculta se puede cambiar sin eliminar ni volver a crear el índice. Consulta Opción oculta.

Para cambiar las otras opciones del índice, se debe descartar el índice existente con db.collection.dropIndex() antes de ejecutar db.collection.createIndex() con las nuevas opciones.

Opción de intercalación

Opción oculta

Para ocultar o mostrar índices existentes, puede utilizar los siguientes mongosh métodos:

Por ejemplo,

Para cambiar la opción hidden de un índice a true, utiliza el método db.collection.hideIndex():
```
db.restaurants.hideIndex( { borough: 1, ratings: 1 } );
```
Para cambiar la opción hidden de un índice a false, utiliza el método db.collection.unhideIndex():
```
db.restaurants.unhideIndex( { borough: 1, city: 1 } );
```

Tip

Hidden Indexes

Transacciones

Puede crear colecciones e índices dentro de una transacción distribuida si la transacción es No es una transacción de escritura entre fragmentos.

Para usar db.collection.createIndex() en una transacción, la transacción debe usar el nivel de consistencia de lectura "local". Si especificas un nivel de consistencia de lectura distinto de "local", la transacción fallará.

Tip

Crear colecciones e índices en una transacción

Creación de índices

Cambiado en la versión 7.1.

A partir de MongoDB 7.1, la creación de índices se mejora con un reporte de errores más rápido y una mayor resiliencia ante fallos. También puedes establecer el espacio mínimo disponible en disco necesario para la creación de índices utilizando el nuevo parámetro indexBuildMinAvailableDiskSpaceMB, que detiene la creación de índices si el espacio en disco es demasiado bajo.

La siguiente tabla compara el comportamiento de la creación de índices a partir de MongoDB 7.1 con versiones anteriores.

Comportamiento a partir de MongoDB 7.1	Comportamiento en versiones anteriores de MongoDB
Errores de índice encontrados durante la fase de escaneo de colección, excepto los errores de clave duplicada, se devuelven inmediatamente y luego se detiene la creación de índices. Las versiones anteriores de MongoDB devuelven errores en la fase de confirmación, que ocurre cerca del final de la creación de índices. MongoDB 7.1 ayuda a diagnosticar rápidamente los errores de índice. Por ejemplo, si se encuentra un formato de valor de índice incompatible, el error se le devuelve inmediatamente.	Los errores de creación de índices pueden tardar mucho tiempo en ser devueltos en comparación con MongoDB 7.1 porque los errores se devuelven cerca del final de la creación del índice en la fase de confirmación.
Mayor resiliencia para su implementación. Si ocurre un error de creación de índices, un miembro secundario puede solicitar que el miembro primario detenga la creación de un índice y el miembro secundario no se bloquee. Una solicitud para detener una creación de índices no siempre es posible: si un nodo ya ha votado por la confirmación del índice, entonces el secundario no puede solicitar que la creación del índice se detenga y el secundario se bloquea (similar a MongoDB 7.0 y anteriores).	Un error en la creación de índices puede causar que un secundario se bloquee.
Mejora de la gestión del espacio en disco para la creación de índices. Es posible que la creación de índices se detenga automáticamente si el espacio disponible en el disco es inferior al mínimo especificado en el parámetro `indexBuildMinAvailableDiskSpaceMB`. Si un nodo ya ha votado para la confirmación del índice, entonces la creación de índices no se detiene.	La creación de índices no se detiene si no hay suficiente espacio disponible en el disco.

Ejemplos

Crear un índice ascendente en un solo campo

El siguiente ejemplo crea un índice ascendente en el campo orderDate.

db.collection.createIndex( { orderDate: 1 } )

Si el documento keys especifica más de un campo, entonces createIndex() crea un índice compuesto.

Crear un índice en varios campos

El siguiente ejemplo crea un índice compuesto en el campo orderDate (en orden ascendente) y en el campo zipcode (en orden descendente).

db.collection.createIndex( { orderDate: 1, zipcode: -1 } )

Los índices compuestos pueden incluir un solo campo encriptado. Los índices compuestos encriptados requieren que featureCompatibilityVersion se establezca al menos en 5.0.

El siguiente ejemplo crea un índice compuesto en el campo state (en orden ascendente) y en el campo zipcode (encriptado):

db.collection.createIndex( { "state" : 1, "zipcode" : "hashed" } )

El orden de los campos en un índice compuesto es importante para admitir operaciones sort() utilizando el índice.

Tip

Crear índices con la intercalación especificada

El siguiente ejemplo crea un índice llamado category_fr. El ejemplo crea el índice con la intercalación que especifica la localización fr y la fuerza de comparación 2:

db.restaurants.createIndex(
   { category: 1 },
   { name: "category_fr", collation: { locale: "fr", strength: 2 } }
)

El siguiente ejemplo crea un índice compuesto llamado date_category_fr con una intercalación. La intercalación se aplica solo a las claves de índice con valores de string.

db.collection.createIndex(
   { orderDate: 1, category: 1 },
   { name: "date_category_fr", collation: { locale: "fr", strength: 2 } }
)

La intercalación se aplica a las claves indexadas cuyos valores son string.

Para queries u operaciones de ordenación en las claves indexadas que utilizan las mismas reglas de intercalación, MongoDB puede usar el índice. Los índices utilizan la intercalación de strength: 2, lo que da lugar a queries que no distinguen entre mayúsculas y minúsculas cuando se utiliza el índice. Para obtener más detalles, consulta Intercalación y uso del índice.

Crear un índice comodín

Los índices comodín omiten el campo _id por defecto. Para incluir el campo _id en el índice comodín, debes incluirlo explícitamente en el documento wildcardProjection:
```
{
  "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
  }
}
```
Todas las instrucciones en el documento wildcardProjection deben ser de inclusión o de exclusión. También puede incluir el campo _id con las instrucciones de exclusión. Esta es la única excepción a la regla.
Los índices comodín no son compatibles con:
Los índices comodín son índices escasos. No ofrecen soporte para consultas cuando no existe un campo indexado. Un índice comodín indexará el documento si el campo comodín tiene un valor de null.
A partir de MongoDB 7.0, los índices comodín admiten el orden de clasificación ascendente (1) y descendente (-1). Las versiones anteriores solo admitían el orden ascendente.

Para obtener más información, consulta:

Para ver ejemplos, consulta:

Crear un índice comodín en una ruta de un solo campo
Crear un índice comodín en todas las rutas de campos
Incluir campos específicos en la cobertura de índices comodín
Omitir campos específicos de la cobertura de índices comodín

Crear un índice comodín en una ruta de un solo campo

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Jeans",
    product_attributes: {
      price: {
        cost: 29.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Sweater",
    product_attributes: {
      washable: true,
      size: [ "small", "medium", "large" ]
    }
  }
] )

La siguiente operación crea un índice comodín en el campo product_attributes:

use inventory
db.products_catalog.createIndex( { "product_attributes.$**" : 1 } )

Con este índice comodín, MongoDB indexa todos los valores escalares de product_attributes. Si el campo es un documento o arreglo anidado, el índice comodín recorre el documento/arreglo e indexa todos los campos escalares del documento/arreglo.

El índice comodín puede brindar soporte a queries arbitrarias de un solo campo en product_attributes o en uno de sus campos anidados:

db.products_catalog.find( { "product_attributes.washable" : true } )
db.products_catalog.find( { "product_attributes.maxSize" : { $gt : 20 } } )
db.products_catalog.find( { "product_attributes.colors" : { $eq: "blue" } } )

Nota

La sintaxis del índice comodín específica de la ruta es incompatible con la opción wildcardProjection. Consulte la documentación de parámetros para obtener más información.

Crear un índice comodín en todas las rutas de campos

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Jeans",
    product_attributes: {
      price: {
        cost: 29.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Sweater",
    product_attributes: {
      washable: true,
      size: [ "small", "medium", "large" ]
    }
  }
] )

La siguiente operación crea un índice comodín en todos los campos escalares (excluyendo el campo _id):

use inventory
db.products_catalog.createIndex( { "$**" : 1 } )

Con este índice comodín, MongoDB indexa todos los campos escalares de cada documento de la colección. Si un campo dado es un documento o arreglo anidado, el índice comodín recorre el documento/arreglo e indexa todos los campos escalares del documento/arreglo.

El índice creado puede soportar queries sobre cualquier campo arbitrario dentro de los documentos de la colección:

db.products_catalog.find( { "product_price" : { $lt : 25 } } )
db.products_catalog.find( { "product_attributes.colors" : { $eq: "blue" } } )

Nota

Los índices comodín omiten el campo _id por defecto. Para incluir el campo _id en el índice comodín, se debe incluir explícitamente en el documento wildcardProjection. Consulta la documentación de parámetros para obtener más información.

Incluir campos específicos en la cobertura de índices comodín

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Jeans",
    product_attributes: {
      price: {
        cost: 29.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Sweater",
    product_attributes: {
      washable: true,
      size: [ "small", "medium", "large" ]
    }
  }
] )

La siguiente operación crea un índice comodín y utiliza la opción wildcardProjection para incluir únicamente los valores escalares de los campos product_attributes.colors y product_attributes.material en el índice.

use inventory
db.products_catalog.createIndex(
  { "$**" : 1 },
  {
    "wildcardProjection" : {
      "product_attributes.colors" : 1,
      "product_attributes.material" : 1
    }
  }
)

El patrón "$**" incluye todos los campos del documento. Se debe usar el campo wildcardProjection para limitar el índice a los campos que se especifiquen. Para obtener la documentación completa sobre wildcardProjection, se debe consultar Opciones para índices wildcard.

Si un campo es un documento o un arreglo anidado, el índice comodín se adentra en él e indexa todos los campos escalares del documento o del arreglo.

El índice comodín admite consultas en cualquier campo escalar incluido en el wildcardProjection:

db.products_catalog.find( { "product_attributes.colors" : { $eq: "Blue" } } )
db.products_catalog.find( { "product_attributes.material" : "Cotton" } )

Nota

Los índices comodín no soportan mezclar instrucciones de inclusión y exclusión en el documento wildcardProjection excepto cuando se incluye explícitamente el campo _id. Para obtener más información sobre wildcardProjection, consulta la documentación de los parámetros.

Omitir campos específicos de la cobertura de índices comodín

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Jeans",
    product_attributes: {
      price: {
        cost: 29.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Sweater",
    product_attributes: {
      washable: true,
      size: [ "small", "medium", "large" ]
    }
  }
] )

Este ejemplo utiliza un índice comodín y un documento wildcardProjection para indexar los campos escalares de cada documento de la colección.

El índice comodín excluye los campos product_attributes.colors y product_attributes.material:

use inventory
db.products_catalog.createIndex(
  { "$**" : 1 },
  {
    "wildcardProjection" : {
      "product_attributes.colors" : 0,
      "product_attributes.material" : 0
    }
  }
)

El patrón comodín "$**" incluye todos los campos del documento. Sin embargo, el campo wildcardProjection excluye los campos especificados del índice.

Para obtener la documentación completa sobre wildcardProjection, consulta Opciones para índices wildcard.

Si un campo es un documento o un arreglo anidado, el índice comodín recorre el documento/arreglo e indexa todos los campos escalares del documento/arreglo.

El índice puede tener soporte para queries en cualquier campo escalar excepto aquellos excluidos por wildcardProjection:

db.products_catalog.find( { "product_attributes.maxSize" : { $gt: 25 } } )
db.products_catalog.find( { "product_attributes.washable" : true } )

Nota

Crear un índice con quórum de confirmación

Nota

Requiere featureCompatibilityVersion 4.4+

Cada mongod en el set de réplicas o clúster debe tener featureCompatibilityVersion configurada al menos en 4.4 para iniciar la creación de índices simultáneamente en los miembros del set de réplicas.

La creación de índices en un set de réplicas o en un clúster se realiza simultáneamente en todos los miembros del set de réplicas que contienen datos. Para clústeres fragmentados, la creación de índices solo ocurre en fragmentos que contienen datos para la colección que se está indexando. El primario requiere un número mínimo de nodos portadores de datos voting (es decir, quórum de confirmación), incluido él mismo, que deben completar la compilación antes de marcar el índice como listo para usar. Consulta creación de índices en entornos replicados para obtener más información.

Para establecer el quórum de confirmación, utiliza createIndex() para especificar el valor de commitQuorum.

commitQuorum especifica cuántos nodos votantes con datos o cuáles, incluido el primario, deben estar preparados para confirmar la creación de índices antes de que el primario ejecute la confirmación. El quórum de confirmación por defecto es votingMembers, lo que significa todos los nodos con datos.

La siguiente operación crea un índice con un quórum de confirmación de "majority", o una mayoría simple de miembros votantes con datos:

db.getSiblingDB("examples").invoices.createIndex(
  { "invoices" : 1 },
  { },
  "majority"
)

El primario marca la creación de índices como lista solo después de que una mayoría simple de nodos votantes con datos "vote" para confirmar la creación de índices. Para obtener más información sobre la creación de índices y el proceso de votación, consulta Creación de índices en entornos replicados.

Información Adicional

Consulta la sección Índices de este manual para obtener la documentación completa sobre los índices y la indexación en MongoDB.
db.collection.getIndexes() para visualizar las especificaciones de los índices existentes de una colección.
Índices de texto en implementaciones autogestionadas para obtener más detalles sobre la creación de índices text.
Índices geoespaciales para queries geoespaciales.
Índices TTL para la expiración de los datos.

Volver

db.collection.countDocuments

db.collection.createIndexes

Definición

Compatibilidad

Nota

Sintaxis

Parámetros

opciones

Opciones para todos los tipos de índices

Opción para intercalación

Tip

Uso de la intercalación y del índice

Tip

Advertencia

Importante

Opciones para text Índices

Opciones para 2dsphere Índices

Opciones para 2d Índices

Opciones para wildcard índices

Comportamientos

Recreación de un índice existente

Opciones del índice

Opciones sin intercalación y no ocultas

Opción de intercalación

Opción oculta

Tip

Transacciones

Tip

Creación de índices

Ejemplos

Crear un índice ascendente en un solo campo

Crear un índice en varios campos

Tip

Crear índices con la intercalación especificada

Crear un índice comodín

Crear un índice comodín en una ruta de un solo campo

Nota

Crear un índice comodín en todas las rutas de campos

Nota

Incluir campos específicos en la cobertura de índices comodín

Nota

Omitir campos específicos de la cobertura de índices comodín

Nota

Crear un índice con quórum de confirmación

Nota

Requiere featureCompatibilityVersion 4.4+

Información Adicional

Opciones para `text` Índices

Opciones para `2dsphere` Índices

Opciones para `2d` Índices

Opciones para `wildcard` índices