createIndexes (comando de base de datos)

Definición

createIndexes: Compila uno o más índices en una colección.
Tip
In mongosh, this command can also be run through the db.collection.createIndex() and db.collection.createIndexes() helper methods.
Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

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

Nota

This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.

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

The createIndexes command takes the following form:

db.runCommand(
   {
     createIndexes: <collection>,
     indexes: [
         {
             key: {
                 <key-value_pair>,
                 <key-value_pair>,
                 ...
             },
             name: <index_name>,
             <option1>,
             <option2>,
             ...
         },
         { ... },
         { ... }
     ],
     writeConcern: { <write concern> },
     commitQuorum: <int|string>,
     comment: <any>
   }
 )

Campos de comandos

The createIndexes command takes the following fields:

Campo	Tipo	Descripción
`createIndexes`	string	La colección para la que crear índices.
`indexes`	arreglo	Especifica los índices que se deben crear. Cada documento del arreglo especifica un índice por separado.
`writeConcern`	Documento	Opcional. Un documento que expresa el nivel de confirmación de escritura. Omite el uso del nivel de confirmación de escritura por defecto.
`commitQuorum`	entero o cadena de texto	opcional. El número mínimo de miembros del set de réplicas que contienen datos (es decir, quórum de confirmación), incluyendo el primario, que debe informar una creación de índices exitosa antes de que el primario marque el `indexes` como listo. Puede reanudar algunas creaciones de índices interrumpidas cuando el quórum de confirmación está configurado en el valor por defecto `"votingMembers"`. Consulte `setIndexCommitQuorum`. Los nodos del set de réplicas en un quórum de confirmación deben tener `members[n].buildIndexes` configurado en `true`. Si algún nodo de votación tiene `members[n].buildIndexes` establecido en `false`, no puedes usar el quórum de confirmación por defecto `"votingMembers"`. Configure todos los nodos con `members[n].buildIndexes` establecido en `true`, o seleccione un quórum de confirmación diferente. Admite los siguientes valores: `"votingMembers"` - todos los nodos votantes con datos del set de réplicas (por defecto). Nodo "votante" es cualquier nodo del set de réplicas donde `members[n].votes` es mayor que `0`. `"majority"` - una mayoría simple de los miembros del set de réplicas que contienen datos. `<int>` - un número específico de miembros del set de réplicas que contienen datos. `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.
`comment`	any	Opcional. Un comentario proporcionado por el usuario para adjuntar a este comando. Una vez configurado, este comentario aparece junto a los registros de este comando en las siguientes ubicaciones: Mensajes de registro de mongod, en el campo `attr.command.cursor.comment`. Salida del perfilador de base de datos, en el campo `command.comment`. `currentOp` de salida, en el campo `command.comment`. Un comentario puede ser de cualquier tipo BSON válido (string, objeto, arreglo, etc.).

Cada documento en el arreglo indexes puede incluir los siguientes campos:

Campo

Tipo

Descripción

key

Documento

Especifica los campos del índice. Para cada campo, especifique un par clave-valor en el que la clave sea el nombre del campo a indexar y el valor sea la dirección del índice o el tipo de índice. Si se especifica la dirección, especifique 1 para ascendente o -1 para descendente.

MongoDB admite varios tipos de índices diferentes, incluidos:

Consulta tipos de índices para obtener más información.

Los índices comodín compatibles con cargas de trabajo donde los usuarios consultan campos personalizados o una amplia 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 detalles, consulte Índices comodín.

name

string

Un nombre que identifica de manera única el índice.

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.

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

Si estás utilizando cifrado a nivel de campo del lado del cliente o Queryable Encryption, un partialFilterExpression no puede hacer referencia a un campo cifrado.

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 2dsphere clave(s) de índice junto con claves de otros tipos, solo los campos de índice de 2dsphere determinan si el índice hace referencia a un documento.

MongoDB proporciona la opción de crear índices parciales. Éstas ofrecen un superconjunto de la funcionalidad de los índices dispersos y se prefieren en su lugar.

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 query. Un índice oculto no se evalúa como parte de la selección del plan del 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.

weights

Documento

Optional. For text indexes, a document that contains field and weight pairs. The weight is an integer ranging from 1 to 99,999 and denotes the significance of the field relative to the other indexed fields in terms of the score. You can specify weights for some or all the indexed fields. See Assign Weights to Text Search Results to adjust the scores. The default value is 1.

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.

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.

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 para los valores de longitud y latitud. El valor por defecto es -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.

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.

wildcardProjection

Documento

Opcional.

Permitir a los usuarios incluir o excluir rutas de campo específicas de un índice comodín utilizando el patrón de clave { "$**" : 1}. Esta opción solo es válida si se crea un índice comodín en todos los campos del documento. No puede especificar esta opción si está creando un índice comodín en una ruta de campo específica y sus subcampos, por ejemplo, { "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.

mongosh provides the methods db.collection.createIndex() and db.collection.createIndexes() as wrappers for the createIndexes command.

Considerations

MongoDB no permite la creación de índices de la versión 0.

Nombres de índices

The createIndexes command and mongosh helpers db.collection.createIndex() and db.collection.createIndexes() report an error if you create an index with one name, and then try to create the same index again but with another name.

{
   "ok" : 0,
   "errmsg" : "Index with name: x_1 already exists with a different name",
   "code" : 85,
   "codeName" : "IndexOptionsConflict"
}

En versiones anteriores, MongoDB no volvía a crear el índice, sino que devolvía un objeto de respuesta con un valor ok de 1 y una nota que implicaba que el índice no se había recreado. Por ejemplo:

{
   "numIndexesBefore" : 2,
   "numIndexesAfter" : 2,
   "note" : "all indexes already exist",
   "ok" : 1
}

Sets de réplicas y clústeres

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 iniciar una creación de índices con un cuórum de confirmación distinto del por defecto, especifique el cuórum de confirmación.

Utilice el comando setIndexCommitQuorum para modificar el quórum de confirmación de una creación de índices en curso.

Tipos de intercalación y de índices

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.

Stable API

Cuando se debe utilizar Stable API V1:

No puedes especificar ninguno de los siguientes campos en el arreglo indexes:
- background
- bucketSize
- sparse
- storageEngine
No puedes crear índices de texto.
Los tipos de índice no admitidos mencionados anteriormente son ignorados por el planificador de consultas en modo estricto. Por ejemplo, intentar usar un índice sparse con cursor.hint() dará como resultado el siguiente error BadValue:
planner returned error :: caused by :: hint provided does not correspond to an existing index

Comportamiento

Simultaneidad

For featureCompatibilityVersion "4.2", createIndexes uses an optimized build process that obtains and holds an exclusive lock on the specified collection at the start and end of the index build. All subsequent operations on the collection must wait until createIndexes releases the exclusive lock. createIndexes allows interleaving read and write operations during the majority of the index build.

Para featureCompatibilityVersion, "4.0" createIndexes utiliza el4 2 proceso de creación de índices pre-. que, por defecto, obtiene un bloqueo exclusivo en la base de datos principal durante toda la duración del proceso de creación. El4 2 proceso de creación pre-. bloquea todas las operaciones en la base de datos y todas sus colecciones hasta que la operación se complete. Losbackground índices no toman un bloqueo exclusivo.

For more information on the locking behavior of createIndexes, see Index Builds on Populated Collections.

Límite de uso de memoria

createIndexes admite la creación de uno o más índices en una colección. createIndexes utiliza una combinación de memoria y archivos temporales en disco para crear índices. El límite de memoria predeterminado es de 200 megabytes por comando, compartido equitativamente entre todos los índices creados en ese comando. Por ejemplo, si createIndexes crea 10 índices con un createIndexes comando, MongoDB asigna a cada índice 20 megabytes para el proceso de creación del índice cuando se utiliza el 200 límite de memoria predeterminado de. Cuando se alcanza el límite de memoria, MongoDB crea archivos temporales en el _tmp subdirectorio dentro de --dbpath para completar la creación.

Ajuste el límite de memoria con el parámetromaxIndexBuildMemoryUsageMegabytes. Aumentar este parámetro solo es necesario en casos excepcionales, como cuando se ejecutan varias compilaciones de índices simultáneas con un solo comandocreateIndexeso cuando se indexa un conjunto de datos mayor de 500GB.

Cada comandocreateIndexestiene un límite demaxIndexBuildMemoryUsageMegabytes. Al usar el valor predeterminadomaxNumActiveUserIndexBuildsde 3, el uso total de memoria para todas las construcciones de índices concurrentes puede alcanzar hasta 3 veces el valor demaxIndexBuildMemoryUsageMegabytes.

Opciones del índice

Non-Hidden Option

The hidden option can be changed without dropping and recreating the index. See Hidden Option.

Cambiar las Opciones de Índice

Collation options on an existing index can be updated. To change other index options, drop the existing index with db.collection.dropIndex() then run createIndexes with the new options.

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.

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.

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.

Opción oculta

To change the hidden option for existing indexes, you can use the following mongosh methods:

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

Índices 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:

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.

To use createIndexes in a transaction, the transaction must use read concern "local". If you specify a read concern level other than "local", the transaction fails.

Tip

Crear colecciones e índices en una transacción

Quórum de confirmación en contraste con el nivel de confirmación de escritura

Existen diferencias importantes entre los quorum de confirmación y niveles de confirmación de escritura (write concern):

Las compilaciones de índices utilizan quórums de confirmación.
Las operaciones de escritura usan nivel de confirmación de escritura (write concern).

Cada nodo que lleva datos en un clúster es un miembro votante.

El quórum de confirmación especifica cuántos miembros votantes portadores de datos, o cuáles miembros votantes, incluido el primario, deben estar preparados para confirmar una creación de índices simultánea antes de que el primario ejecute la confirmación.

El nivel de confirmación de escritura (write concern) es el nivel de confirmación que la operación de escritura ha alcanzado en el número especificado de instancias.

El quórum de confirmación especifica cuántos nodos deben estar listos para finalizar la creación de índices antes de que el primario confirme la creación de índices. Por el contrario, cuando el primario ha realizado la creación de índices, el nivel de confirmación de escritura (write concern) especifica cuántos nodos deben finalizar la creación de índices antes de que el comando devuelva una respuesta.

Ejemplo

El siguiente comando construye dos índices en la colección inventory de la base de datos products:

db.getSiblingDB("products").runCommand(
  {
    createIndexes: "inventory",
    indexes: [
        {
            key: {
                item: 1,
                manufacturer: 1,
                model: 1
            },
            name: "item_manufacturer_model",
            unique: true
        },
        {
            key: {
                item: 1,
                supplier: 1,
                model: 1
            },
            name: "item_supplier_model",
            unique: true
        }
    ],
    writeConcern: { w: "majority" }
  }
)

Cuando los índices terminan de construirse con éxito, MongoDB devuelve un documento de resultados que incluye un estado de "ok" : 1.

Crear un índice comodín

Nota

Para la documentación completa sobre los Índices comodín, consulta Índices comodín.

Las siguientes listas muestran ejemplos de la creación de índices comodín:

Crear un índice comodín en una ruta de un solo campo
Crear un índice comodín en todas las rutas de campos
Crea un índice comodín en varias rutas de campo específicas
Crea un índice comodín que excluya varias rutas de campos específicas

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

Considera una colección products_catalog donde los documentos pueden contener un campo product_attributes. El product_attributes campo puede contener campos anidados arbitrarios, incluidos documentos incrustados y arreglos:

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Blaster Gauntlet",
    product_attributes: {
      price: {
        cost: 299.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Super Suit",
    product_attributes: {
      superFlight: true,
      resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
    }
  }
] )

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

use inventory
db.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "product_attributes.$**" : 1 },
        name: "wildcardIndex"
      }
    ]
  }
)

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.superFlight" : true } )
db.products_catalog.find( { "product_attributes.maxSpeed" : { $gt : 20 } } )
db.products_catalog.find( { "product_attributes.elements" : { $eq: "water" } } )

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: "Blaster Gauntlet",
    product_attributes: {
      price: {
        cost: 299.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Super Suit",
    product_attributes: {
      superFlight: true,
      resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
    }
  }
] )

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

use inventory
db.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "$**" : 1 },
        name: "wildcardIndex"
      }
    ]
  }
)

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.elements" : { $eq: "water" } } )

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.

Crea un índice comodín en varias rutas de campo específicas

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Blaster Gauntlet",
    product_attributes: {
      price: {
        cost: 299.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Super Suit",
    product_attributes: {
      superFlight: true,
      resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
    }
  }
] )

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.elements y product_attributes.resistance en el índice.

use inventory
db.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "$**" : 1 },
        "wildcardProjection" : {
          "product_attributes.elements" : 1,
          "product_attributes.resistance" : 1
        },
        name: "wildcardIndex"
      }
    ]
  }
)

Aunque el patrón clave "$**" abarca todos los campos del documento, el campo wildcardProjection limita el índice solo a los campos incluidos y los campos anidados relacionados.

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 creado puede soportar queries en cualquier campo escalar incluido en el wildcardProjection:

db.products_catalog.find( { "product_attributes.elements" : { $eq: "Water" } } )
db.products_catalog.find( { "product_attributes.resistance" : "Bludgeoning" } )

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.

Crea un índice comodín que excluya varias rutas de campos específicas

db.products_catalog.insertMany( [
  {
    _id : ObjectId("5c1d358bf383fbee028aea0b"),
    product_name: "Blaster Gauntlet",
    product_attributes: {
      price: {
        cost: 299.99,
        currency: "USD"
      }
    }
  },
  {
    _id: ObjectId("5c1d358bf383fbee028aea0c"),
    product_name: "Super Suit",
    product_attributes: {
      superFlight: true,
      resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
    }
  }
] )

La siguiente operación crea un índice comodín y utiliza el documento wildcardProjection para indexar todos los campos escalares de cada documento en la colección, excluyendo los campos product_attributes.elements y product_attributes.resistance:

use inventory
db.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "$**" : 1 },
        "wildcardProjection" : {
           "product_attributes.elements" : 0,
           "product_attributes.resistance" : 0
        },
        name: "wildcardIndex"
      }
    ]
  }
)

Mientras que el patrón clave "$**" cubre todos los campos en el documento, el campo wildcardProjection excluye los campos especificados del índice.

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 creado puede admitir consultas sobre cualquier campo escalar excepto aquellos excluidos por wildcardProjection:

db.products_catalog.find( { "product_attributes.maxSpeed" : { $gt: 25 } } )
db.products_catalog.find( { "product_attributes.superStrength" : true } )

Nota

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

Nota

Requiere featureCompatibilityVersion 4.4+

To set the commit quorum, use createIndexes to specify the commitQuorum value.

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.

The following operation creates an index with a commit quorum of "majority", or a simple majority of data-bearing members:

db.getSiblingDB("examples").runCommand(
  {
    createIndexes: "invoices",
    indexes: [
      {
        key: { "invoices" : 1 },
        "name" : "invoiceIndex"
      }
    ],
    "commitQuorum" : "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.

Salida

The createIndexes command returns a document that indicates the success of the operation. The document contains some but not all of the following fields, depending on outcome:

createIndexes.createdCollectionAutomatically: Si true, entonces la colección no existía y se creó durante el proceso de creación del índice.

createIndexes.numIndexesBefore: El número de índices al inicio del comando.

createIndexes.numIndexesAfter: El número de índices al final del comando.

createIndexes.ok: Un valor de 1 indica que los índices están implementados. Un valor de 0 indica un error.

createIndexes.note: Este note se devuelve si ya existe un índice o índices existentes. Esto indica que el índice no fue creado ni cambiado.

createIndexes.errmsg: Devuelve información sobre cualquier error.

createIndexes.code: El código de error que representa el tipo de error.

Ejemplo de salida

El siguiente bloque de código ilustra un ejemplo de la salida createIndexes en un clúster particionado. En un clúster, createIndexes genera un documento incrustado raw que contiene un documento para cada partición en el que se construye el índice. Las claves del documento incrustado raw son concatenaciones del ID de partición y el nombre de host y puerto de los nodos individuales que componen la partición.

{
  raw: {
    'atlas-2m11gv-shard-1/atlas-2m11gv-shard-01-00.cpfgx.mongodb.net:27017,atlas-2m11gv-shard-01-01.cpfgx.mongodb.net:27017,atlas-2m11gv-shard-01-02.cpfgx.mongodb.net:27017': {
      numIndexesBefore: 3,
      numIndexesAfter: 5,
      createdCollectionAutomatically: false,
      commitQuorum: 'votingMembers',
      ok: 1
    },
    'atlas-2m11gv-shard-0/atlas-2m11gv-shard-00-00.cpfgx.mongodb.net:27017,atlas-2m11gv-shard-00-01.cpfgx.mongodb.net:27017,atlas-2m11gv-shard-00-02.cpfgx.mongodb.net:27017': {
      numIndexesBefore: 3,
      numIndexesAfter: 5,
      createdCollectionAutomatically: false,
      commitQuorum: 'votingMembers',
      ok: 1
    }
  },
  ok: 1,
  '$clusterTime': {
    clusterTime: Timestamp({ t: 1743624296, i: 7 }),
    signature: {
      hash: Binary.createFromBase64('22j0GK8SIK806T+0OdCY6qYHocM=', 0),
      keyId: Long('7438621020069560323')
    }
  },
  operationTime: Timestamp({ t: 1743624296, i: 7 })
}

Volver

Cree

currentOp