Docs Menu
Docs Home
/ / /
PHP Library Manual
/ /


On this page

  • Definition
  • Parameters
  • Return Values
  • Errors/Exceptions
  • Example
  • See Also

New in version 1.10.


Rename a collection within the current database.

function renameCollection(
string $fromCollectionName,
string $toCollectionName,
?string $toDatabaseName = null,
array $options = []
): array|object
$fromCollectionName : string
The name of the collection to rename.
$toCollectionName : string
The new name of the collection.
$toDatabaseName : string
The new database name of the collection. If a new database name is not specified, the current database will be used. If the new name specifies a different database, the command copies the collection to the new database and drops the source collection.
$options : array

An array specifying the desired options.


Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.

This option is available since MongoDB 4.4 and will result in an exception at execution time if specified for an older server version.

New in version 1.13.

If true, MongoDB will drop the target before renaming the collection. The default value is false.

Client session to associate with the operation.


The type map to apply to cursors, which determines how BSON documents are converted to PHP values. Defaults to the database's type map.

This will be used for the returned command result document.


Write concern to use for the operation. Defaults to the database's write concern.

An array or object with the result document of the renameCollection command. The return type will depend on the typeMap option.

MongoDB\Exception\UnsupportedException if options are used and not supported by the selected server (e.g. collation, readConcern, writeConcern).

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\RuntimeException for other errors at the extension level (e.g. connection errors).

The following example renames the restaurants collection in the test database to places:

$db = (new MongoDB\Client)->test;
$result = $db->renameCollection('restaurants', 'places');

The output would then resemble:

object(MongoDB\Model\BSONDocument)#8 (1) {
array(1) {
← modifyCollection()