db.collection.renameCollection()
Nesta página
MongoDB com drivers
Esta página documenta um método mongosh. Para ver o método equivalente em um driver MongoDB, consulte a página correspondente da sua linguagem de programação:
Definição
db.collection.renameCollection(target, dropTarget)Renomeia uma coleção. Fornece um wrapper para o comando
renameCollectionde banco de dados.ParâmetroTipoDescriçãotargetstring
O novo nome da coleção. Coloque a string entre aspas. Consulte Restrições de nomenclatura.
dropTargetbooleano
Opcional. Se
true,mongodelimina otargetderenameCollectionantes de renomear a collection. O valor padrão éfalse.
Comportamento
O método db.collection.renameCollection() opera dentro de uma coleção alterando os metadados associados com uma determinada coleção.
Consulte a documentação renameCollection para obter avisos e mensagens adicionais.
Aviso
O método db.collection.renameCollection() e o comando renameCollection invalidarão os cursores abertos, o que interrompe as queries que estão retornando dados no momento.
Para Change Streams, o método db.collection.renameCollection() e o comando renameCollection criam uma invalidação para qualquer Change Streams existente aberto na coleção de origem ou de destino.
O método tem as seguintes limitações:
db.collection.renameCollection()não pode mover uma coleção entre bancos de dados. UserenameCollectionpara essas operações de renomeação.Não é possível renomear visualizações.
db.collection.renameCollection()não é suportado em coleções de séries temporais.Você não pode renomear uma collection para si mesma. Se você tentar renomear uma collection para si mesma, um erro
IllegalOperationserá gerado.
Bloqueio de recursos em clusters fragmentados
Alterado na versão 5.0.
Ao renomear uma collection fragmentada ou não fragmentada em um cluster fragmentado, as collections de origem e de destino são bloqueadas exclusivamente em cada shard. As operações subsequentes nas collections de origem e de destino devem aguardar até que a operação de renomeação seja concluída.
Para obter mais informações sobre bloqueios no MongoDB, consulte as Perguntas frequentes: simultaneidade.
Bloqueio de recursos em conjuntos de réplicas
renameCollection() obtém um bloqueio exclusivo nas coleções de origem e destino durante a operação. Todas as operações subsequentes nas coleções devem aguardar até que renameCollection() seja concluído.
Interação com mongodump
Um mongodump iniciado com --oplog falha se um cliente emitir db.collection.renameCollection() durante o processo de despejo. mongodump.--oplog Consulte para mais informações.
Exemplo
Chame o método db.collection.renameCollection() em um objeto de coleção. Por exemplo:
db.rrecord.renameCollection("record")
Esta operação renomeará a coleção rrecord para record. Se o nome do destino (ou seja record) é o nome de uma coleção existente, então a operação falhará.