sh.moveCollection.txt

===================
sh.moveCollection()
===================

.. default-domain:: mongodb

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

Definition
----------

.. method:: sh.moveCollection(namespace, toShard)

   .. |mc| replace:: ``sh.moveCollection()``
   .. |sc| replace:: :method:`sh.shardCollection()`
   .. |rsc| replace:: :method:`sh.reshardCollection()`
   .. include:: /includes/mc-description.rst

   .. |dbcommand| replace:: :dbcommand:`moveCollection` command
   .. include:: /includes/fact-mongosh-shell-method-alt.rst

Syntax
------

``sh.moveCollection()`` has the following syntax:

.. code-block:: javascript
  
   sh.moveCollection( "<namespace>", "<toShard>" )
  

Parameters
~~~~~~~~~~
  
``sh.moveCollection()`` takes the following parameters:

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

   * - Parameter
     - Type
     - Description

   * - ``namespace``
     - string
     - Database and name of the collection to move.

   * - ``toShard``
     - string
     - ID of the recipient shard.

Compatibility
-------------

.. |command| replace:: method

This method is available in deployments hosted in the following environments:

.. include:: /includes/fact-environments-atlas-only.rst

.. note:: 

   This command is not available on the Atlas Shared Tier.

.. include:: /includes/fact-environments-onprem-only.rst

.. _moveCollection-method-considerations:

Considerations
--------------

.. include:: /includes/mc-considerations.rst

.. _moveCollection-method-reqs:

Requirements
------------

.. include:: /includes/mc-reqs.rst

Examples
--------

This example moves an unsharded collection named ``inventory`` on the
``app`` database to the ``shard02`` shard.

.. code-block:: javascript
  
   sh.moveCollection( "app.inventory", "shard02" )  

.. include:: /includes/mc-sh-status.rst

Learn More
----------

- :dbcommand:`moveCollection`
- :ref:`moveable-collections`