/ /

Comandos de base de datos

Administración

Docs Home

Manual de base de datos

Referencia

Comandos de base de datos

Administración

renameCollection (comando de base de datos)

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 6.0, consulta el Procedimientos de actualización de MongoDB.7.0

Definición

renameCollection

Cambia el nombre de una colección existente. Especifique los nombres de colección como renameCollection en forma de un archivo completo. namespace (<database>.<collection>).

Tip

En mongosh, este comando también se puede ejecutar a través del método asistente renameCollection().

Los métodos asistente son convenientes para usuarios de mongosh, pero es posible que no proporcionen el mismo nivel de información que los comandos de base de datos. En los casos en que no se necesite la conveniencia o se requieran campos de retorno adicionales, utiliza el comando de base de datos.

Ejecuta el comando renameCollection en la base de datos admin.

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

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 comando tiene la siguiente sintaxis:

db.runCommand(
   {
     renameCollection: "<source_namespace>",
     to: "<target_namespace>",
     dropTarget: <true|false>,
     writeConcern: <document>,
     comment: <any>
   }
)

Campos de comandos

El comando contiene los siguientes campos:

Campo	Tipo	Descripción
`renameCollection`	string	El namespace de la colección que se desea renombrar. El namespace es una combinación del nombre de la base de datos y el nombre de la colección.
`to`	string	El nuevo namespace de la colección. Si el nuevo namespace especifica una base de datos diferente, el comando `renameCollection` copia la colección a la nueva base de datos y descarta la colección de origen. Consulta Restricciones de nomenclatura
`dropTarget`	booleano	opcional. Si `true`, `mongod` descartará el `target` de `renameCollection` antes de renombrar la colección. El valor por defecto es `false`.
`writeConcern`	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 `renameCollection` y su asistente `db.collection.renameCollection()` a `"majority"`.
`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.).

Comportamiento

Colecciones fragmentadas

A partir de MongoDB 5.0, se puede usar el comando renameCollection para cambiar el nombre de una colección particionada. La base de datos destino debe ser la misma que la base de datos de origen.

Colecciones no particionadas

Se puede usar renameCollection para renombrar una colección no particionada en un clúster siempre que las bases de datos de origen y destino estén en la misma partición primaria.

Colecciones de series de tiempo

No puedes utilizar renameCollection para renombrar una colección de series de tiempo. Para obtener más información, consulta Limitaciones de la colección de series de tiempo.

Colección de objetivos existente

renameCollection falla si target es el nombre de una colección existente y no dropTarget: true especifica.

Rendimiento

Cambiado en la versión 3.6.

renameCollection tiene diferentes implicancias de rendimiento según el espacio de nombresde destino.

Si la base de datos de destino es la misma que la de origen, simplemente cambia el espacio de nombres. Esta operación esrenameCollection rápida.

Si la base de datos de destino difiere de la base de datos de origen, renameCollection copia todos los documentos de la colección de origen a la colección de destino. Dependiendo del tamaño de la colección, esto puede tardar más en completarse.

Bloqueo de recursos en clústeres compartidos

Modificado en la versión 5.0.

Al cambiar el nombre de una colección particionada o no particionada en un clúster, las colecciones de origen y destino se bloquean exclusivamente en cada partición. Las operaciones posteriores en las colecciones de origen y destino deben esperar hasta que se complete la operación de cambio de nombre.

Para obtener más información sobre el bloqueo en MongoDB, consulta FAQ: Concurrency.

Bloqueo de recursos en conjuntos de réplicas

Si se cambia el nombre de una colección dentro de la misma base de datos, renameCollection obtiene un bloqueo exclusivo en las colecciones de origen y destino durante toda la operación. Todas las operaciones posteriores en las colecciones deben esperar hasta que renameCollection se complete.

Si se renombra una colección entre diferentes bases de datos, renameCollection se obtiene un bloqueo exclusivo (W) en la base de datos de destino, un bloqueo compartido con intención (r) en la base de datos de origen, y un bloqueo compartido (S) en la colección de origen. Las operaciones posteriores en la base de datos de destino deben esperar hasta que renameCollection libere el bloqueo exclusivo de la base de datos.

Para obtener más información sobre el bloqueo en MongoDB, consulta FAQ: Concurrency.

`local` Database

No puede renombrar una colección de una base de datos replicada a la base de datos local, que no está replicada.
No se puede cambiar el nombre de una colección de la base de datos local, que no está replicada, a una base de datos replicada.

Abrir cursores

Advertencia

El db.collection.renameCollection() método y renameCollection el comando invalidarán los cursores abiertos que interrumpen las consultas que actualmente están devolviendo datos.

Flujos de cambio

Para Change Streams, o método db.collection.renameCollection() e o comando renameCollection criam um evento de invalidação para qualquer Change Streams aberto na colección de origem o de destino.

Interacción con `mongodump`

Una mongodump iniciada con --oplog falla si un cliente emite el comando renameCollection durante el proceso de vaciado. Consulta mongodump.--oplog para obtener más información.

Ejemplo

El siguiente ejemplo renombra una colección llamada orders en la base de datos test a orders2014 en la base de datos test.

db.adminCommand( { renameCollection: "test.orders", to: "test.orders2014" } )

mongosh provee el db.collection.renameCollection() asistente para el comando de renombrar colecciones dentro de la misma base de datos. Lo siguiente es equivalente al ejemplo anterior:

use test
db.orders.renameCollection( "orders2014" )

Volver

reIndex

rotateCertificates