replSetGetConfig (comando de banco de dados)

Definição

replSetGetConfig: Retorna um documento que descreve a configuração atual do conjunto de réplicas.
Dica
In mongosh, this command can also be run through the rs.conf() helper method.
Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.

Compatibilidade

Esse comando está disponível em implantações hospedadas nos seguintes ambientes:

MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

Importante

Esse comando não é suportado em clusters M0 e Flex. Para obter mais informações, consulte Comandos não suportados.

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Sintaxe

To run, replSetGetConfig must be issued against the admin database. The command has the following syntax:

db.adminCommand(
   {
     replSetGetConfig: 1,
     commitmentStatus: <boolean>,
     comment: <any>
   }
)

Campos de comando

Campo	Tipo	Descrição
`replSetGetConfig`	any	Qualquer valor
status do compromisso	booleano	Optional. Specify `true` to include a commitmentStatus field in the output. The commitmentStatus output field indicates whether the replica set's previous reconfig has been committed, so that the replica set is ready to be reconfigured again. For details, see commitmentStatus Output Field. Você só pode especificar a opção `commitmentStatus: true` ao executar o comando no primary. Os erros de comando se forem executados com `commitmentStatus: true` em um secundário.
`comment`	any	Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais: mensagens de log do mongod, no campo `attr.command.cursor.comment`. Saída do perfil do banco de dados, no campo `command.comment`. Saída de `currentOp`, no campo `command.comment`. Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc).

mongosh provides the rs.conf() method that wraps the replSetGetConfig command:

rs.conf();

Exemplo de saída

The following is an example output of the replSetGetConfig command run with commitmentStatus: true on the primary:

{
   "config" : {
      "_id" : "myRepl",
      "version" : 180294,
      "term" : 1,
      "protocolVersion" : Long(1),
      "writeConcernMajorityJournalDefault" : true,
      "members" : [
         {
            "_id" : 0,
            "host" : "m1.example.net:27017",
            "arbiterOnly" : false,
            "buildIndexes" : true,
            "hidden" : false,
            "priority" : 1,
            "tags" : {
            },
            "secondaryDelaySecs" : Long(0),
            "votes" : 1
         },
         {
            "_id" : 1,
            "host" : "m2.example.net:27017",
            "arbiterOnly" : false,
            "buildIndexes" : true,
            "hidden" : false,
            "priority" : 1,
            "tags" : {
            },
            "secondaryDelaySecs" : Long(0),
            "votes" : 1
         },
         {
            "_id" : 2,
            "host" : "m3.example.net:27017",
            "arbiterOnly" : false,
            "buildIndexes" : true,
            "hidden" : false,
            "priority" : 1,
            "tags" : {
            },
            "secondaryDelaySecs" : Long(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" : Long("6821298283919441923")
      }
   },
   "operationTime" : Timestamp(1588212091, 1)
}

Campo	Descrição
`config`	A configuração do conjunto de réplicas. Para obter uma descrição de cada definição de configuração, consulte Configuração do conjunto de réplicas autogerenciadas.
status do compromisso	Um booleano que indica se a configuração mais recente do conjunto de réplicas foi confirmada; isto é, A configuração do conjunto de réplicas mais recente para o primário foi propagada para a maioria dos membros, e A última operação de gravação no conjunto de réplicas com a configuração anterior foi `majority-committed` na nova configuração. If `true`, then the configuration has been committed, and the replica set can be reconfigured. To reconfigure the replica set, see `replSetReconfig` command or the `mongosh` method `rs.reconfig()`. Se `false`, a configuração não foi confirmada e o conjunto de réplicas não pode ser reconfigurado.
`ok`	Um número que indica se o comando foi bem-sucedido (`1`) ou falhou (`0`).
`operationTime` `$clusterTime`	Retornado com cada comando para um conjunto de réplicas. Consulte Resposta db.adminCommand para obter detalhes.

Dica

Voltar

replSetFreeze

replSetGetStatus