定義
balancerStatus
バージョン 3.4 で追加。
バランサーの状態に関する情報を含むドキュメントを返します。
balancerStatus
はadmin
データベースに対してのみ発行できます。Tip
mongosh
では、このコマンドはsh.isBalancerRunning()
ヘルパー メソッドを通じて実行することもできます。ヘルパー メソッドは
mongosh
ユーザーには便利ですが、データベースコマンドと同じレベルの情報は返されない可能性があります。 便宜上必要ない場合、または追加の戻りフィールドが必要な場合は、 データベースコマンドを使用します。
互換性
このコマンドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
重要
このコマンドはサーバーレスインスタンスではサポートされていません。 詳細については、「サポートされていないコマンド 」を参照してください。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
構文
このコマンドの構文は、次のとおりです。
db.adminCommand( { balancerStatus: 1 } )
出力ドキュメント
以下は、 コマンドによって返されるドキュメントの例えです。
{ "mode" : "full", "inBalancerRound" : false, "numBalancerRounds" : NumberLong(86), "ok" : 1 }
フィールド | 説明 |
---|---|
| バランサー スレッドが実行中か停止かを指定する string。 可能な値は次のとおりです。
|
| バランサー がバランシング ラウンド内かどうかを指定するブール値。
|
| コンフィギュレーションサーバー が起動されて以降に発生した バランサー ラウンドの数。 この値は保持されず、コンフィギュレーションサーバーの再起動時に 0 にリセットされます。 |
例
mongos
インスタンスに接続し、次のコマンドを発行します。
db.adminCommand( { balancerStatus: 1 } )