sh.enableBalancing.txt

=====================
sh.enableBalancing()
=====================

.. default-domain:: mongodb

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

Description
-----------

.. method:: sh.enableBalancing(namespace)

   Enables the balancer for the specified namespace of the sharded collection.

   .. important::

      You can only run :method:`sh.enableBalancing()` on a
      :binary:`~bin.mongos` instance. :method:`sh.enableBalancing()`
      errors if run on :binary:`~bin.mongod` instance.

   The :method:`sh.enableBalancing()` method has the following parameter:


   .. list-table::
      :header-rows: 1
      :widths: 20 20 80
   
      * - Parameter
   
        - Type
   
        - Description
   
      * - ``namespace``
   
        - string
   
        - The :term:`namespace` of the collection.


   .. important:: 

      :method:`sh.enableBalancing()` does not *start*
      balancing. Rather, it allows balancing of this collection the
      next time the balancer runs.

   For more information on the balancing process, see
   :doc:`/tutorial/manage-sharded-cluster-balancer` and
   :ref:`sharding-balancing`.

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

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

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