sh.enableAutoMerger.txt

=====================
sh.enableAutoMerger()
=====================

.. default-domain:: mongodb

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

Definition
----------

.. method:: sh.enableAutoMerger(namespace)

.. versionadded:: 7.0

.. include:: /includes/enableAutoMerger.rst

``sh.enableAutoMerger()`` is a :binary:`~bin.mongosh` helper method. It
is effectively the same as running the 
:dbcommand:`configureCollectionBalancing` command with the 
``enableAutoMerger`` field set to ``true``.

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

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

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

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

.. include:: /includes/fact-environments-atlas-support-no-free.rst

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

Syntax
------

.. code-block:: javascript

   sh.enableAutoMerger( <namespace> )

Method Field
------------

.. include:: /includes/auto-merger-namespace-field.rst

Behavior
--------

.. include:: /includes/auto-merger-time-parameters.rst

Example
-------

The following example enables automatic chunk merges for
``"testDatabase.myCollection"``. Run the example from
:binary:`~bin.mongos`:

.. code-block:: javascript

   sh.enableAutoMerger( "testDatabase.myCollection" )

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

- :ref:`automerger-concept`
- :method:`sh.disableAutoMerger()` method
- :method:`sh.startAutoMerger()` method
- :method:`sh.stopAutoMerger()` method

.. include:: /includes/auto-merger-learn-more.rst