sh.stopBalancer()

定義

sh.stopBalancer(timeout, interval)

バージョン 4.2 で変更。

シャーディングされたクラスター内のバランサーを無効にします。 MongoDB 4.2以降では、 sh.stopBalancer()もシャーディングされたクラスターの自動分割を無効にします。

重要

mongosh メソッド

このページでは、mongosh メソッドについて記載しています。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません。

データベースコマンドについては、 balancerStopコマンドを参照してください。

MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。

メソッドは次のオプションを取ることができます。

Parameter	タイプ	説明
timeout	integer	バランサーを無効にする時間制限。 デフォルトは 60000 ミリ秒です。 バージョン 3.4 で変更: 3.4 mongo shell を以前のバージョンのシャーディングされたクラスターで使用する場合、 パラメーターはバランシング ラウンドが停止するまで待機するミリ秒量を指定します。
interval	integer	バランシング ラウンドが停止したかどうかを確認する間隔（ミリ秒単位）。

両方のオプションを省略すると、MongoDB はバランサーを無期限に無効にします。

重要

バランサーを長期間無効のままにすると、シャードのバランスが取れず、クラスターのパフォーマンスが低下する可能性があります。 必要な場合のみバランサーを無効にし、メンテナンスが完了した後にバランサーを再度有効にするようにします。

インスタンスではのみsh.stopBalancer() mongosを実行できます。sh.stopBalancer()mongod{ インスタンスで実行すると エラーが発生します。

mongo shell メソッドは、3.4 で導入されたbalancerStopコマンドのラッパーです。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

動作

バランシング ラウンドが進行中の場合、 操作はバランシングが完了するまで待機します。

詳細

• sh.enableBalancing()

• sh.disableBalancing()

• sh.getBalancerState()

• sh.isBalancerRunning()

• sh.setBalancerState()

• sh.startBalancer()

• sh.waitForBalancer()

• sh.waitForBalancerOff()