sh.startBalancer() (mongoshメソッド)

定義

sh.startBalancer(timeout, interval)

バージョン7.0で変更。

シャーディングされたクラスターでバランサーを起動します。

MongoDB 7.0 以降では、バランサーを起動すると、シャーディングされたクラスターの AutoMerger も有効になります。

重要

mongosh メソッド

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

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

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

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

Parameter	タイプ	説明
timeout	integer	任意。 バランサーを有効にするための時間制限。 デフォルトは 60000 ミリ秒です。
interval	integer	任意。 バランシング ラウンドが開始されたかどうかを確認する頻度（ミリ秒単位）。

You can only run sh.startBalancer() on a mongos instance. sh.startBalancer() errors if run on mongod instance.

互換性

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

• MongoDB Atlas はクラウドでの MongoDB 配置のための完全管理サービスです

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

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

動作

The mongosh shell method sh.startBalancer() is a wrapper around the balancerStart command. sh.startBalancer() runs the balancerStart command in the background and returns immediately.

詳細

クラスターのバランサーを設定する方法については、クラスター バランサーの管理を参照してください。

特定のコレクションのバランシングを無効にするには、コレクションのバランシングの無効化を参照してください。

特定のコレクションでバランシングを再度有効にするには、コレクションでのバランシングの有効化を参照してください。

• sh.getBalancerState()

• sh.isBalancerRunning()

• sh.setBalancerState()

• sh.stopBalancer()

• sh.waitForBalancer()

• sh.waitForBalancerOff()