db.createCollection() (método mongosh)

booleano

Opcional. Para crear una colección con tamaño fijo, especifica true. Si especificas true, también debes establecer un tamaño máximo en el campo size.

string

Requerido al crear una colección de series de tiempo. El nombre del campo que contiene la fecha en cada documento de serie de tiempo. Los documentos en una colección de series de tiempo deben tener una fecha BSON válida como valor para el timeField.

string

Opcional. El nombre del campo que contiene metadatos en cada documento de serie de tiempo. Los metadatos en el campo especificado deben ser datos utilizados para etiquetar una serie única de documentos. Los metadatos deberían cambiar rara vez, o nunca.

El nombre del campo especificado no puede ser _id ni el mismo que el timeseries.timeField. El campo puede ser de cualquier tipo excepto un arreglo.

string

Opcional, no lo utilices si se configura bucketRoundingSeconds y bucketMaxSpanSeconds. Los valores posibles son seconds (por defecto), minutes y hours.

Configura granularity al valor que más se asemeje al intervalo de tiempo entre las marcas de tiempo entrantes consecutivas. Esto mejora el rendimiento al optimizar cómo MongoDB almacena internamente los datos en la colección.

Para obtener más información sobre la granularidad y los intervalos de agrupación, consulta Configurar granularidad para datos de series de tiempo.

entero

Opcional, se utiliza con bucketRoundingSeconds como una alternativa a granularity. Establece el tiempo máximo entre marcas de tiempo en el mismo bucket. Los valores posibles son de 1 a 31536000. Si configuras bucketMaxSpanSeconds, debes configurar bucketRoundingSeconds al mismo valor.

Para degradar a una versión anterior a MongoDB 6.3, debes modificar la colección para utilizar el valor granularity correspondiente o descartar la colección. Para obtener más detalles, consulta collMod.

entero

Opcional, se utiliza con bucketMaxSpanSeconds como una alternativa a granularity. Establece el número de segundos para redondear hacia abajo cuando MongoDB establece la marca de tiempo mínima para un nuevo bucket. Debe ser igual a bucketMaxSpanSeconds.

Por ejemplo, al establecer ambos parámetros en 1800, los nuevos intervalos se redondean a los 30 minutos más cercanos. Si un documento con una marca de tiempo de 2023-03-27T18:24:35Z no encaja en un bucket existente, MongoDB crea un nuevo bucket con un tiempo mínimo de 2023-03-27T18:00:00Z y un tiempo máximo de 2023-03-27T18:30:00Z.

Número

Opcional. Especifica los segundos después de los cuales los documentos en una colección de series de tiempo o colección con índice clusterizado expiran. MongoDB elimina automáticamente los documentos caducados.

Para colecciones con índice clusterizado, los documentos se eliminan automáticamente en función de la clave de índice agrupada _id y los valores deben ser de tipo fecha. Consulta los índices TTL.

Documento

A partir de MongoDB 5.3, puedes crear una colección con un índice agrupado. Los índices agrupados se almacenan en el mismo archivo WiredTiger de la colección. La colección resultante se llama colección con índice clusterizado.

El campo clusteredIndex tiene la siguiente sintaxis:

clusteredIndex: {
   key: <object>,
   unique: <boolean>,
   name: <string>
}

key

Requerido. El campo clave del índice agrupado. Debe estar configurado en { _id: 1 }. El valor por defecto del campo _id es un objectId único generado automáticamente, pero puedes establecer tus propios valores de clave de índice agrupado.

unique

Requerido. Debe establecerse en true. Un índice único indica que la colección no aceptará documentos insertados o actualizados si el valor de la clave del índice agrupado coincide con un valor ya existente en el índice.

name

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

Documento

Opcional.

A partir de MongoDB 6.0, puedes utilizar eventos de flujo de cambios para generar la versión de un documento antes y después de los cambios (las imágenes previas y posteriores del documento):

• La imagen previa es el documento antes de reemplazarlo, actualizarlo o borrarlo. No existe una imagen previa para un documento insertado.

• La imagen posterior es el documento tras insertarse, sustituirse o actualizarse. No hay imagen posterior para un documento borrado.

• Activa changeStreamPreAndPostImages para una colección con db.createCollection(), create o collMod. Por ejemplo, cuando se utiliza el comando collMod:

  db.runCommand( {
     collMod: <collection>,
     changeStreamPreAndPostImages: { enabled: true }
  } )

changeStreamPreAndPostImages tiene la siguiente sintaxis:

changeStreamPreAndPostImages: {
   enabled: <boolean>
}

Para habilitar las imágenes previas y posteriores del flujo de cambios para la colección, se debe establecer enabled en true.

Para obtener ejemplos completos con la salida del flujo de cambios, consulta Flujos de cambio con imágenes previas y posteriores de documentos.

Para un ejemplo de db.createCollection() en esta página, se debe consultar Crear una colección con imágenes previas y posteriores de Change Stream para documentos.

Número

Opcional. Especifica un tamaño máximo en bytes para una colección con tamaño fijo. Una vez que una colección con tamaño fijo alcanza su tamaño máximo, MongoDB remueve los documentos más antiguos para dejar espacio a los nuevos documentos. El campo size es obligatorio para las colecciones con tamaño fijo y se ignora para las demás colecciones.

Número

Opcional. El número máximo de documentos permitidos en la colección con tamaño fijo. El límite de size tiene prioridad sobre este límite. Si una colección con tamaño fijo alcanza el límite size antes de alcanzar el número máximo de documentos, MongoDB remueve los documentos antiguos. Si prefieres usar el límite de max, asegúrate de que el límite de size, que es necesario para una colección con tamaño fijo, sea suficiente para contener el número máximo de documentos.

Documento

Opcional. Disponible solo para el motor de almacenamiento WiredTiger.

Permite a los usuarios especificar la configuración para el motor de almacenamiento por colección al crear una colección. El valor de la opción storageEngine debe tomar la siguiente forma:

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

La configuración del motor de almacenamiento especificada al crear colecciones se valida y se registra en el oplog durante la replicación para soportar conjuntos de set de réplicas con miembros que utilizan diferentes motores de almacenamiento.

A partir de MongoDB 7.2, no se pueden especificar opciones de cifrado del motor de almacenamiento wiredTiger al crear una colección con db.createCollection(). Para configurar el cifrado para el motor de almacenamiento WiredTiger, consulta Cifrado en reposo.

Para obtener detalles, consulte Especificar opciones del motor de almacenamiento.

Documento

Opcional. Permite a los usuarios especificar reglas o expresiones de validación para la colección.

La opción validator requiere un documento que especifique las reglas o expresiones de validación. Puedes especificar las expresiones utilizando los mismos operadores que los operadores del query, con la excepción de $near, $nearSphere, $text, y $where.

Para aprender a crear una colección con validación de esquema, consulta Especificar la validación de esquemas JSON.

string

Opcional. Determina con qué rigor MongoDB aplica las reglas de validación a los documentos existentes durante una actualización.

"off"

No hay validación para inserciones o actualizaciones.

"strict"

Por defecto, aplica reglas de validación a todas las inserciones y a todas las actualizaciones.

"moderate"

Aplica reglas de validación a las inserciones y a las actualizaciones en documentos válidos existentes. No apliques reglas a las actualizaciones en documentos inválidos existentes.

Para ver un ejemplo que utiliza validationLevel, consulte Especificar nivel de validación para documentos existentes.

string

Opcional. Determina si se debe mostrar error en documentos no válidos o solo warn sobre las infracciones, pero permite que se inserten documentos no válidos.

IMPORTANTE: La validación de documentos solo se aplica a aquellos documentos según lo determinado por el validationLevel.

Para ver un ejemplo que utiliza validationAction, consulte Elija cómo gestionar documentos no válidos.

Documento

Opcional. Permite a los usuarios especificar una configuración por defecto para los índices al crear una colección.

La opción indexOptionDefaults acepta un documento storageEngine, el cual debe tener la siguiente forma:

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

La configuración del motor de almacenamiento especificada al crear índices se valida y se registra en el oplog durante la replicación para admitir sets de réplicas con miembros que utilizan diferentes motores de almacenamiento.

string

El nombre de la colección o vista de origen desde la cual crear una vista. Para obtener más detalles, consulta db.createView().

arreglo

Un arreglo que consta de las etapas de la canalización de agregación. db.createView() crea una vista aplicando el pipeline especificado a la colección o vista viewOn. Para obtener más detalles, consulta db.createView().

Documento

Especifica la intercalación por defecto para la colección.

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.

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.

Si especificas una intercalación a nivel de colección:

• Los índices de esa colección se crearán con esa intercalación a menos que la operación de creación del índice especifique explícitamente una intercalación diferente.

• Las operaciones en esa colección utilizan la intercalación por defecto de la colección, a menos que especifiquen explícitamente una intercalación diferente.

  No puedes especificar varias intercalaciones para una operación. Por ejemplo, no puedes especificar diferentes intercalaciones por campo, o si realizas una búsqueda con un ordenamiento, no puedes usar una intercalación para la búsqueda y otra para el ordenamiento.

Si no se especifica ninguna intercalación para la colección o para las operaciones, MongoDB utiliza la comparación binaria simple usada en versiones anteriores para las comparaciones de strings.

Para una colección, solo puedes especificar la intercalación durante la creación de la colección. Una vez establecida, no puedes modificar la intercalación por defecto de la colección.

Para un ejemplo, ver Especificar la intercalación.

Documento

Opcional. Un documento que expresa el nivel de confirmación de escritura para la operación. Omite usar el nivel de confirmación de escritura por defecto.

Cuando se emite en un clúster particionado, mongos convierte el nivel de confirmación de escritura del comando create y su asistente db.createCollection() a "majority".