sh.startBalancer()

定義

sh.startBalancer(timeout, interval)

バージョン 4.2 で変更。

シャーディングされたクラスターでバランサーを起動します。 MongoDB 4.2以降では、 sh.startBalancer()によってシャーディングされたクラスターの自動分割も有効になります。

重要

mongosh メソッド

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

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

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

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

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

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

互換性

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

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

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

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

動作

MongoDB 3.4以降、 mongo shellメソッドsh.startBalancer()はbalancerStartコマンドのラッパーです。 そのため、 メソッドはバランシングが開始されるのを待たない。

以前のバージョンでは、 メソッドはバランシングが開始されるのを待機していました。