MongoDB con controladores
Esta página documenta a mongosh . Para ver el método equivalente en un driver de MongoDB, se debe consultar la página correspondiente al lenguaje de programación:
Definición
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 |
|---|---|---|
| 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 Un asterisco ( MongoDB admite varios tipos de índices diferentes, incluidos: 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.
|
| Documento | Opcional. Un documento que contiene un conjunto de opciones que controlan la creación del índice. Consulta Opciones para obtener más detalles. |
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 Admite los siguientes valores:
|
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 varias opciones de índice en el mismo documento. Sin embargo, si se especifican varios documentos de opciones, la operación db.collection.createIndex() falla.
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 | |
|---|---|---|---|
| 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 La opción no está disponible para índices encriptados. | |
| 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. | |
| 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:
Puedes especificar una opción | |
| booleano | Opcional. Si Los siguientes tipos de índices son escasos por defecto e ignoran esta opción: Para un índice compuesto que incluye claves de índice 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. | |
| 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 | |
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 | ||
| Documento | Opcional. Permite a los usuarios configurar el motor de almacenamiento por índice al crear un índice. La opción 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. |
Opciones de intercalación
Parameter | Tipo | Descripción | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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:
La opción de intercalación tiene la siguiente sintaxis: Al especificar la intercalación, el campo |
Los siguientes índices solo soportan la comparación binaria simple y no soportan la intercalación:
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
Las claves de índice sensibles a la intercalación pueden ser más grandes que las claves de índice que no la utilizan, ya que los índices configurados con intercalación utilizan claves de intercalación ICU para lograr un orden de clasificación.
Opciones para text Índices
Las siguientes opciones están disponibles solo para los índices de texto:
Parameter | Tipo | Descripción |
|---|---|---|
| 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 A partir de MongoDB 5.0, la opción pesos solo está permitida para los índices de texto. |
| 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 |
| 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 |
| entero | Opcional. El número de versión del índice 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 |
|---|---|---|
| entero | Opcional. El número de versión del índice 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 |
|---|---|---|
| entero | Opcional. Para los índices 2d, el número de cifras significativas del valor geohash almacenado de los datos de ubicación. El valor |
| Número | Opcional. Para los índices |
| Número | Opcional. Para los índices |
Opciones para índices wildcard
Los índices comodín pueden usar la opción wildcardProjection.
Parameter | Tipo | Descripción | |||||||
|---|---|---|---|---|---|---|---|---|---|
| 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
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
La opción El
|
Para obtener más información, consulta:
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
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.
Opción oculta
Para ocultar o mostrar índices existentes, puede utilizar los siguientes mongosh métodos:
Por ejemplo,
Para cambiar la opción
hiddende un índice atrue, utiliza el métododb.collection.hideIndex():db.restaurants.hideIndex( { borough: 1, ratings: 1 } ); Para cambiar la opción
hiddende un índice afalse, utiliza el métododb.collection.unhideIndex():db.restaurants.unhideIndex( { borough: 1, city: 1 } );
Transacciones
Puedes crear colecciones e índices dentro de una transacción distribuida si la transacción no es una transacción de escritura entre particiones.
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á.
Comprometer Quórum
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.
Ejemplos
Los ejemplos de esta página utilizan datos del conjunto de datos de muestra sample_mflix. Para obtener más información sobre cómo cargar este conjunto de datos en la implementación autogestionada de MongoDB, consultar Cargar el conjunto de datos de muestra. Si se realizó alguna modificación en las bases de datos de muestra, es posible que se deban descartar y volver a crear las bases de datos para ejecutar los ejemplos de esta página.
Nota
Los document en la colección movies contienen campos adicionales que no se muestran aquí.
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 los campos year, runtime y title:
db.movies.createIndex( { year: 1, runtime: 1, title: 1 } )
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" } )
For more information on hashed indexes, see Hashed Indexes.
Create Indexes with Collation
Utiliza el siguiente código para crear un índice en la colección movies de la base de datos sample_mflix con la configuración regional de intercalación "fr" para comparaciones de string:
db.movies.createIndex( { title: 1 }, { collation: { locale: "fr" } } )
La siguiente query, que especifica la misma intercalación que el índice, puede utilizar el índice:
db.movies.find( { title: "Les Misèrables" }, { title: 1, year: 1 } ).collation( { locale: "fr" } )
Sin embargo, la siguiente operación de query, que por defecto utiliza el comparador binary "simple", no puede utilizar el índice y requiere un COLLSCAN.
db.movies.find( { title: "Les Misèrables" }, { title: 1 , year: 1 } )
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, puedes utilizar el siguiente código para crear un índice compuesto en la colección movies de la base de datos sample_mflix, especificando los campos numéricos year y metacritic y el campo string title. El índice también especifica la intercalación "fr" para las comparaciones de string:
db.movies.createIndex( { year: 1, metacritic: 1, title: 1 }, { collation: { locale: "fr" } } )
Las siguientes operaciones, que utilizan la intercalación binaria "simple" para las comparaciones de strings, pueden usar el índice:
db.movies.find( { year: 2012 }, { title: 1, year: 1, metacritic: 1 } ).sort( { title: 1 } )
db.movies.find( { year: 2012, metacritic: { $gt: Decimal128( "50" ) } }, { title: 1, year: 1, metacritic: 1 } ).sort( { title: 1 } )
La siguiente operación, que utiliza la intercalación binaria "simple" para las comparaciones de string en el campo title indexado, puede usar el índice para cumplir solo con la parte year: 2012 de la query:
db.movies.find( { year: 2012, title: "Les Misèrables" }, { year: 1, title: 1 } )
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.
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" } } )
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" } } )
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
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.
Crear un índice con quórum de confirmación
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.