Docs Menu
Docs Home
/
MongoDBマニュアル
/
参照
/
データベース コマンド
/
複製

replSetGetConfig

項目一覧

  • 定義
  • 互換性
  • 構文
  • 出力例

定義

replSetGetConfig

レプリカセット の現在の 構成 を説明するドキュメントを返します。

Tip

mongoshでは、このコマンドはrs.conf()ヘルパー メソッドを通じて実行することもできます。

ヘルパー メソッドはmongoshユーザーには便利ですが、データベースコマンドと同じレベルの情報は返されない可能性があります。 便宜上必要ない場合、または追加の戻りフィールドが必要な場合は、 データベースコマンドを使用します。

互換性

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

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

重要

このコマンドは、M 0 、M 2 、M 5クラスターではサポートされていません。 詳細については、「サポートされていないコマンド 」を参照してください。

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

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

構文

実行するには、 adminデータベースに対してreplSetGetConfigを発行する必要があり、構文は次のとおりです。

db.adminCommand( {
   replSetGetConfig: 1,
   commitmentStatus: <boolean>,
   comment: <any>
} );
フィールド
タイプ
説明

replSetGetConfig

any

任意の値

commitStatus

ブール値

任意。出力にtrue commitStatusフィールドを含めるには、 を指定します。 commitStatus 出力フィールドは、レプリカセットの以前の再構成がコミットされたかどうかを示し、レプリカレプリカセットを再度再構成する準備が整っているかどうかを示します。詳細については、 commitStatus 出力 フィールド を参照してください。

プライマリで コマンドを実行する場合にのみcommitmentStatus: trueオプションを指定できます。 セカンダリでcommitmentStatus: trueを使用して実行すると、コマンドはエラーになります。

comment

any

任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。

コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。

mongoshには、rs.conf() コマンドをラップするreplSetGetConfig メソッドが用意されています。

rs.conf();

出力例

以下は、プライマリで commitStatus: truereplSetGetConfig を指定して実行された コマンドの出力の例です。

{
   "config" : {
      "_id" : "myRepl",
      "version" : 180294,
      "term" : 1,
      "protocolVersion" : NumberLong(1),
      "writeConcernMajorityJournalDefault" : true,
      "members" : [
         {
            "_id" : 0,
            "host" : "m1.example.net:27017",
            "arbiterOnly" : false,
            "buildIndexes" : true,
            "hidden" : false,
            "priority" : 1,
            "tags" : {
            },
            "secondaryDelaySecs" : NumberLong(0),
            "votes" : 1
         },
         {
            "_id" : 1,
            "host" : "m2.example.net:27017",
            "arbiterOnly" : false,
            "buildIndexes" : true,
            "hidden" : false,
            "priority" : 1,
            "tags" : {
            },
            "secondaryDelaySecs" : NumberLong(0),
            "votes" : 1
         },
         {
            "_id" : 2,
            "host" : "m3.example.net:27017",
            "arbiterOnly" : false,
            "buildIndexes" : true,
            "hidden" : false,
            "priority" : 1,
            "tags" : {
            },
            "secondaryDelaySecs" : NumberLong(0),
            "votes" : 1
         }
      ],
      "settings" : {
         "chainingAllowed" : true,
         "heartbeatIntervalMillis" : 2000,
         "heartbeatTimeoutSecs" : 10,
         "electionTimeoutMillis" : 10000,
         "catchUpTimeoutMillis" : -1,
         "catchUpTakeoverDelayMillis" : 30000,
         "getLastErrorModes" : {
         },
         "getLastErrorDefaults" : {
            "w" : 1,
            "wtimeout" : 0
         },
         "replicaSetId" : ObjectId("5eaa1e9ac4d650aa7817623d")
      }
   },
   "commitmentStatus" : true,
   "ok" : 1,
   "$clusterTime" : {
      "clusterTime" : Timestamp(1588212091, 1),
      "signature" : {
         "hash" : BinData(0,"veOHa2mOeRTzuR0LKqnzGxWV77k="),
         "keyId" : NumberLong("6821298283919441923")
      }
   },
   "operationTime" : Timestamp(1588212091, 1)
}
フィールド
説明

config

レプリカセットの構成。 各構成設定の説明については、「自己管理型レプリカセットの構成 」を参照してください。

commitStatus

最新のレプリカセット構成がコミットされたかどうかを示すブール値。すなわち

  • プライマリの最新のレプリカセット構成が大多数のノードに反映され、 かつ

  • 以前の構成のレプリカセットへの最後の書込み操作は、新しい構成ではmajority-commitedでした。

trueの場合、構成はコミットされ、レプリカセットは再構成できます。 レプリカセットを再構成するには、 replSetReconfigコマンドまたはmongoshメソッドrs.reconfig()を参照してください。

falseの場合、構成はコミットされておらず、レプリカセットは再構成できません。

ok

コマンドが成功したか（ 1 ）失敗したか（ 0 ）を示す数値。

operationTime
$clusterTime

レプリカセットのすべてのコマンドで返されます。 詳細については、 db.adminCommand レスポンスを参照してください。

Tip

以下も参照してください。

戻る

replSetfreeze

次へ

replSetGetStatus