Definición
renameCollectionCambia el nombre de una colección existente. Especifique los nombres de colección como
renameCollectionen forma de un nombre completo. espacio de nombres ().<database>.<collection>Tip
En
mongosh, este comando también se puede ejecutar a través del métodorenameCollection()auxiliar.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.Ejecute el comando
renameCollectionen 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.
Compatibilidad con Stable API
A partir de MongoDB,8.1 renameCollection se incluye en la API estable1 V. Para usar renameCollection en la API estable, debe conectar su controlador a una implementación que ejecute MongoDB 8.1 o una versión posterior.
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 |
|---|---|---|
| string | El espacio de nombres de la colección que se va a renombrar. Este espacio de nombres es una combinación del nombre de la base de datos y el nombre de la colección. |
| string | El nuevo espacio de nombres de la colección. Si el nuevo espacio de nombres especifica una base de datos diferente, el |
| booleano | Opcional. Si |
| 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, |
| 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:
Un comentario puede ser de cualquier tipo BSON válido (string, objeto, arreglo, etc.). |
Comportamiento
Colecciones fragmentadas
A partir de MongoDB 5.0, puede usar el comando renameCollection para cambiar el nombre de una colección fragmentada. La base de datos de destino debe ser la misma que la de origen.
Colecciones no particionadas
Puede usar renameCollection para cambiar el nombre de una colección no fragmentada en un clúster fragmentado siempre que las bases de datos de origen y de destino tengan el mismo fragmento principal.
Colecciones de series de tiempo
No se puede usar renameCollection para renombrar una colección de series temporales. Para obtener más información, consulte Limitaciones de las colecciones de series temporales.
Colección de objetivos existentes
renameCollection falla si target es el nombre de una colección existente y no dropTarget: true especifica.
Rendimiento
renameCollection tiene diferentes implicaciones de rendimiento según el espacio de nombres de destino.
Si la base de datos de destino es la misma que la de origen, renameCollection simplemente cambia el espacio de nombres. Esta operación es rápida.
Si la base de datos de destino es diferente de la de origen, renameCollection copia todos los documentos de la colección de origen a la de destino. Dependiendo del tamaño de la colección, este proceso puede tardar más.
Bloqueo de recursos en clústeres fragmentados
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, consulte Preguntas frecuentes: Concurrencia.
Bloqueo de recursos en conjuntos de réplicas
Si se renombra una colección dentro de la misma base de datos, renameCollection obtiene un bloqueo exclusivo en las colecciones de origen y destino durante la operación. Todas las operaciones posteriores en las colecciones deben esperar hasta que renameCollection se complete.
Al renombrar una colección entre diferentes bases de datos, renameCollection obtiene un bloqueo exclusivo (W) en la base de datos de destino, un bloqueo compartido (r) por intención 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, consulte Preguntas frecuentes: Concurrencia.
local Database
No se puede cambiar el nombre de 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.
Cursores abiertos y secuencias de cambios
Advertencia
El db.collection.renameCollection() método y renameCollection el comando invalidan los cursores abiertos. Esto crea un evento de invalidación para cualquier flujo de cambios existente abierto en la colección de origen o destino, y también interrumpe las consultas que devuelven datos de la colección renombrada.
Interacción con mongodump
Un mongodump iniciado con falla si un cliente ejecuta --oplog el renameCollection comando durante el proceso de volcado. Consulte para obtener mongodump.--oplog 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 proporciona el db.collection.renameCollection() asistente para el comando que permite renombrar colecciones dentro de la misma base de datos. El siguiente ejemplo es equivalente al anterior:
use test db.orders.renameCollection( "orders2014" )