Menu Docs
Página inicial do Docs
/
Manual do MongoDB
/
Referência
/
Comandos de banco de dados
/
Comandos de replicação

replSetGetConfig

Nesta página

  • Definição
  • Compatibilidade
  • Sintaxe
  • Campos de comando
  • Exemplo de saída

Definição

replSetGetConfig

Retorna um documento que descreve aconfiguração atual do conjunto de réplicas.

Dica

Em mongosh, esse comando também pode ser executado por meio do método auxiliar rs.conf().

Os métodos auxiliares são práticos para os usuários mongosh, mas podem não retornar o mesmo nível de informações que os comandos do banco de dados. Nos casos em que a praticidade não for necessária ou os campos de retorno adicionais forem necessários, use o comando de banco de dados.

Compatibilidade

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

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

Observação

Esse comando não é compatível nos clusters M0, M2 e M5. Para obter mais informações, consulte Comandos sem compatibilidade.

  • 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

Para executar, o replSetGetConfig deve ser emitido no banco de dados admin . O comando tem a seguinte sintaxe:

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

Campos de comando

Campo
Tipo
Descrição
replSetGetConfig
qualquer
Qualquer valor
booleano

Opcional. Especifique true para incluir um campo commitmentStatus no resultado. O campo de saída commitmentStatus indica se a reconfiguração anterior do conjunto de réplicas foi cometida, de modo que o conjunto de réplicas esteja pronto para ser reconfigurado novamente. Para obter detalhes, consulte o campo de saída commitmentStatus.

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
qualquer

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:

Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc).

mongosh fornece o método rs.conf() que envolve o comando replSetGetConfig :

rs.conf();

Exemplo de saída

O seguinte é uma saída de exemplo do comando replSetGetConfig executado com commitmentStatus: true no primário:

{
   "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)
}
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.

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-commited na nova configuração.

Se true, a configuração foi confirmada e o conjunto de réplicas pode ser reconfigurado. Para reconfigurar o conjunto de réplicas, consulte o comando replSetReconfig ou o método { mongosh 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

Veja também:

Voltar

replSetFreeze

Próximo

replSetGetStatus

Nesta página