=============================
MongoDB\\Collection::rename()
=============================

.. versionadded:: 1.10

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\Collection::rename()

   Rename the collection.

   .. code-block:: php

      function rename(
          string $toCollectionName,
          ?string $toDatabaseName = null,
          array $options = []
      ): array|object

Parameters
----------

``$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 database of the original collection 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.

  .. list-table::
     :header-rows: 1
     :widths: 20 20 80

     * - Name
       - Type
       - Description

     * - dropTarget
       - boolean
       - If ``true``, MongoDB will drop the target before renaming the
         collection. The default value is ``false``.

     * - comment
       - mixed
       - .. include:: /includes/extracts/common-option-comment.rst

         .. include:: /includes/extracts/option-requires-4.4.rst

         .. versionadded:: 1.13

     * - session
       - :php:`MongoDB\Driver\Session <class.mongodb-driver-session>`
       - .. include:: /includes/extracts/common-option-session.rst

     * - typeMap
       - array
       - .. include:: /includes/extracts/collection-option-typeMap.rst

         This will be used for the returned command result document.

     * - writeConcern
       - :php:`MongoDB\Driver\WriteConcern <class.mongodb-driver-writeconcern>`
       - .. include:: /includes/extracts/collection-option-writeConcern.rst

         .. include:: /includes/extracts/common-option-writeConcern-transaction.rst

Return Values
-------------

An array or object with the result document of the :manual:`renameCollection
</reference/command/renameCollection>` command. The return type will depend on the
``typeMap`` option.

Errors/Exceptions
-----------------

.. include:: /includes/extracts/error-unsupportedexception.rst
.. include:: /includes/extracts/error-invalidargumentexception.rst
.. include:: /includes/extracts/error-driver-runtimeexception.rst

Example
-------

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

.. code-block:: php

   <?php

   $collection = (new MongoDB\Client)->test->restaurants;

   $result = $collection->rename('places');

   var_dump($result);

The output would then resemble:

.. code-block:: none

   object(MongoDB\Model\BSONDocument)#9 (1) {
     ["storage":"ArrayObject":private]=>
     array(1) {
       ["ok"]=>
       float(1)
     }
   }

See Also
--------

- :phpmethod:`MongoDB\Database::renameCollection()`
- :manual:`renameCollection </reference/command/renameCollection>` command reference in the MongoDB
  manual
