createIndexes (comando de base de datos)

string

La colección para la que crear índices.

arreglo

Especifica los índices que se crearán. Cada documento de la matriz especifica un índice independiente.

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.

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.

A partir de MongoDB v5.0, puede reanudar algunas creaciones de índices interrumpidas cuando el commit quorum is set a "votingMembers".

Los nodos del conjunto de réplicas en un quórum de confirmación deben tener members[n].buildIndexes establecido true en. Si algún nodo con derecho a voto tiene members[n].buildIndexes establecido false en, no podrá usar el "votingMembers" quórum de confirmación predeterminado. 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 miembros del conjunto 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.

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.).

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:

• text

• Geoespacial

• índices encriptados

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.

string

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

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.

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.

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:

• 2dsphere

• 2d

• Text

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.

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.

booleano

Opcional. Indicador que determina si el índice está oculto para el planificador de consultas. Un índice oculto no se evalúa en la selección del plan de consultas.

El valor por defecto es false.

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.

Documento

opcional. Para los índices de texto, un documento que contiene pares de campos y pesos. 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 demás campos indexados en términos de la puntuación. Se pueden especificar ponderaciones para algunos o todos los campos indexados. Consulta Asignar pesos a los resultados de la query de $text en implementaciones autogestionadas para ajustar los puntajes. El valor por defecto es 1.

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 los $text languajes del query en implementaciones autogestionados para conocer los lenguajes disponibles y Specify Language for Text índices en Self-Managed MongoDB para obtener más información y ejemplos. El valor por defecto es english.

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.

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.

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.

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.

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.

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.

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.

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.