db.shutdownServer()
Alterado na versão 5.0.
db.shutdownServer()
Encerra o processo
mongod
oumongos
atual de forma limpa e segura. Você deve executar a operaçãodb.shutdownServer()
no banco de banco de dados admin.db.shutdownServer()
tem esta sintaxe:db.shutdownServer({ force: <boolean>, timeoutSecs: <int> }) O método utiliza estes campos:
CampoDescriçãoOpcional. Especifique
true
para forçar o encerramento demongod
oumongos
. O desligamento forçado interrompe quaisquer operações em andamento nomongod
oumongos
e pode resultar em comportamento inesperado.Você pode pausar e retomar as construções de índices em andamento usando
force
. Consultedb.shutdownServer()
em Membros do Conjunto de Réplicas para obter mais informações.Opcional.
A partir do MongoDB 5.0,
mongod
emongos
entram em um período de desativação para permitir que quaisquer operações de banco de dados em andamento sejam concluídas antes de serem encerradas.Se um
mongod
primário receber uma solicitação de desligamento, o primário:Tentativas de descer para um secundário.
Se a redução falhar e a:
Entra no período de inatividade.
Termina todas as operações restantes do banco de dados.
Desliga.
Para uma solicitação de desligamento secundária ou
mongos
mongod
, o período de desligamento é inserido depois que um desligamento foi solicitado.O período de silêncio é especificado por:
Campo timeoutSecs se um comando
shutdown
oudb.shutdownServer()
foi executado, ouparâmetro de servidor
shutdownTimeoutMillisForSignaledShutdown
se um sinalSIGTERM
foi enviado paramongod
, ouParâmetro do servidor do
mongosShutdownTimeoutMillisForSignaledShutdown
se um sinal doSIGTERM
foi enviado paramongos
.
Os clientes não podem abrir novas conexões com um
mongod
oumongos
que está sendo desligado.timeoutSecs especifica um período de tempo em segundos. O padrão é:
15 segundos começando no MongoDB 5.0.
10 segundos nas versões MongoDB anteriores a 5.0.
mongod
utiliza timeoutSecs como segue:Se o nó atual for o nó primário de um conjunto de réplicas,
mongod
aguardará um período de até o número de segundos especificado pelo campo timeoutSecs para que um nó elegível recupere o atraso antes de reduzir o nó primário. Para obter detalhes sobre o tempo de atualização, consulte atraso de replicação.Se o nó atual estiver no estado
SECONDARY
após deixar de ser primário, qualquer tempo restante especificado em timeoutSecs será usado para um período de inatividade, o que permite que as operações existentes sejam concluídas. Novas operações são enviadas para outros nós do conjunto de réplicas.
A partir do MongoDB 5.0,
mongos
usa timeoutSecs como um período de inatividade, que permite a conclusão das operações existentes. Novas operações são enviadas para outros nósmongos
. Nas versões do MongoDB anteriores a 5.0,mongos
é desligado imediatamente e não usa timeoutSecs.No MongoDB 4.4 e versões anteriores, para um
mongod
primário, timeoutSecs é o número de segundos que o primário deve esperar que um secundário se atualize. Se nenhum secundário for alcançado dentro do tempo especificado, o comando falhará. O padrão é10
segundos.
Esta operação fornece um invólucro para o comando shutdown
.
Compatibilidade
Esse método está disponível em implantações hospedadas nos seguintes ambientes:
Importante
Este comando não é suportado em clusters MongoDB Atlas . Para obter informações sobre o suporte do Atlas para todos os comandos, 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
Comportamento
Para um mongod
iniciado com autenticação em sistemas autogerenciados, você deve executar db.shutdownServer()
em uma conexão autenticada. Consulte Controle de acesso para obter mais informações.
Para um mongod
iniciado sem autenticação em sistemas autogerenciados, você deve executar db.shutdownServer()
de um cliente conectado à interface localhost. Por exemplo, execute mongosh
com a opção --host "127.0.0.1"
na mesma máquina host que o mongod
.
db.shutdownServer()
em Membros do Conjunto de Réplica
db.shutdownServer()
falhará se o nó do conjunto de réplicas mongod
estiver executando determinadas operações, como compilações de índice. Você pode especificar force: true para salvar o progresso da compilação do índice no disco. O mongod
recupera a compilação do índice quando é reiniciado e continua a partir do checkpoint salvo.
Desligando o conjunto de réplicas primário, secundário ou mongos
A partir do MongoDB 5.0, mongod
e mongos
entram em um período de desativação para permitir que quaisquer operações de banco de dados em andamento sejam concluídas antes de serem encerradas.
Se um mongod
primário receber uma solicitação de desligamento, o primário:
Tentativas de descer para um secundário.
Se a redução falhar e a:
Entra no período de inatividade.
Termina todas as operações restantes do banco de dados.
Desliga.
Para uma solicitação de desligamento secundária ou mongos
mongod
, o período de desligamento é inserido depois que um desligamento foi solicitado.
O período de silêncio é especificado por:
Campo timeoutSecs se um comando
shutdown
oudb.shutdownServer()
foi executado, ouparâmetro de servidor
shutdownTimeoutMillisForSignaledShutdown
se um sinalSIGTERM
foi enviado paramongod
, ouParâmetro do servidor do
mongosShutdownTimeoutMillisForSignaledShutdown
se um sinal doSIGTERM
foi enviado paramongos
.
Os clientes não podem abrir novas conexões com um mongod
ou mongos
que está sendo desligado.
timeoutSecs especifica um período de tempo em segundos. O padrão é:
15 segundos começando no MongoDB 5.0.
10 segundos nas versões MongoDB anteriores a 5.0.
mongod
utiliza timeoutSecs como segue:
Se o nó atual for o nó primário de um conjunto de réplicas,
mongod
aguardará um período de até o número de segundos especificado pelo campo timeoutSecs para que um nó elegível recupere o atraso antes de reduzir o nó primário. Para obter detalhes sobre o tempo de atualização, consulte atraso de replicação.Se o nó atual estiver no estado
SECONDARY
após deixar de ser primário, qualquer tempo restante especificado em timeoutSecs será usado para um período de inatividade, o que permite que as operações existentes sejam concluídas. Novas operações são enviadas para outros nós do conjunto de réplicas.
A partir do MongoDB 5.0, mongos
usa timeoutSecs como um período de inatividade, que permite a conclusão das operações existentes. Novas operações são enviadas para outros nós mongos
. Nas versões do MongoDB anteriores a 5.0, mongos
é desligado imediatamente e não usa timeoutSecs.
Aviso
O desligamento forçado do primário pode resultar na rollback de quaisquer gravações ainda não replicadas para um secundário.
Controle de acesso
Para executar o db.shutdownServer()
em um mongod
aplicando a Autenticação em Sistemas Autogerenciados, o usuário autenticado deve ter o privilégio do db.shutdownServer()
. Por exemplo, um usuário com a role incorporada hostManager
tem as permissões apropriadas.
Exemplos
Desligue um mongod
db.getSiblingDB("admin").shutdownServer()
Forçar o desligamento de um mongod
db.getSiblingDB("admin").shutdownServer({ "force" : true })
Desligar um primary mongod
com tempo limite maior
db.getSiblingDB("admin").shutdownServer({ "timeoutSecs": 60 })