On this page

• Definition
• Behavior
• Example

Definition

db.collection. renameCollection ( target, dropTarget )

Renames a collection. Provides a wrapper for the renameCollection database command.

Parameter	Type	Description
target	string	The new name of the collection. Enclose the string in quotes. See Naming Restrictions.
dropTarget	boolean	Optional. If true, mongod drops the target of renameCollection prior to renaming the collection. The default value is false.

Behavior

The db.collection.renameCollection() method operates within a collection by changing the metadata associated with a given collection.

Refer to the documentation renameCollection for additional warnings and messages.

• The method has the following limitations:
  • db.collection.renameCollection() cannot move a collection between databases. Use renameCollection for these rename operations.
  • db.collection.renameCollection() is not supported on sharded collections.
  • You cannot rename views.

Example

Call the db.collection.renameCollection() method on a collection object. For example:

db.rrecord.renameCollection("record")

This operation will rename the rrecord collection to record. If the target name (i.e. record) is the name of an existing collection, then the operation will fail.