Skip to content

Commit 97c657e

Browse files
devkevSam Kleinman
authored andcommitted
manage-sharded-cluster.txt: Clarify stopping the balancer
Strictly speaking, the statement after "sh.setBalancerState(false)" is correct. However it is extremely misleading, because it implies that the setBalancerState command will wait for any current balancing round to finish, which is not true. The "sh.stopBalancer()" helper is the safest way to disable the balancer. Signed-off-by: Sam Kleinman <samk@10gen.com>
1 parent f56fe0b commit 97c657e

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

source/tutorial/manage-sharded-cluster-balancer.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,13 +169,13 @@ all migration, use the following procedure:
169169

170170
.. code-block:: javascript
171171

172-
sh.setBalancerState(false)
172+
sh.stopBalancer()
173173

174174
If a migration is in progress, the system will complete the
175175
in-progress migration before stopping.
176176

177-
#. To verify that the balancer has stopped, issue the following command,
178-
which returns ``false`` if the balancer is stopped:
177+
#. To verify that the balancer will not start, issue the following command,
178+
which returns ``false`` if the balancer is disabled:
179179

180180
.. code-block:: javascript
181181

@@ -195,8 +195,8 @@ all migration, use the following procedure:
195195
.. note::
196196

197197
To disable the balancer from a driver that does not have the
198-
:method:`sh.startBalancer()` helper, issue the following command from
199-
the ``config`` database:
198+
:method:`sh.stopBalancer()` or :method:`sh.setBalancerState()` helpers,
199+
issue the following command from the ``config`` database:
200200

201201
.. code-block:: javascript
202202

0 commit comments

Comments
 (0)