updateZoneKeyRange (comando de banco de dados)

Definição

updateZoneKeyRange

O comando administrativo pode criar ou remover a associação entre um intervalo de valores de chave de shard e updateZoneKeyRange uma zona .

Você pode executar o comando de banco de dados de dados do updateZoneKeyRange e seus auxiliares sh.updateZoneKeyRange() e sh.addTagRange() em uma coleção não compartilhada ou uma coleção não existente.

Dica

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

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.

Para executar updateZoneKeyRange, use o método db.runCommand( { <command> } ).

Você deve executar addShardToZone no banco de dados admin.

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

• 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

O comando tem a seguinte sintaxe:

db.adminCommand(
   {
     updateZoneKeyRange: <string>,
     min: <document>,
     max: <document>,
     zone: <string> | <null>
   }
)

Campos de comando

O comando utiliza os seguintes campos:

Comportamento

Se nenhuma faixa de zona corresponder aos limites mínimo e máximo passados para updateZoneKeyRange, nada será removido.

Emita updateZoneKeyRange somente quando conectado a uma instância mongos .

mongosh fornece dois métodos de ajuda:

• sh.updateZoneKeyRange() para adicionar um intervalo de valores de chave de fragmento a uma zona.

• sh.removeRangeFromZone() para remover um intervalo de valores da chave de fragmento de uma zona.

Você não pode criar uma faixa de valores de chave de shard cujos limites inferior e superior se sobreponham a uma faixa existente para a collection fragmentada. Por exemplo, dado um intervalo existente de 1 a 10, você não pode criar um novo intervalo de 5 a 20, pois o novo intervalo se sobreporia ao intervalo existente.

Uma zona pode ter vários intervalos de dados associados a ela, mas um intervalo pode, no máximo, ser associado a uma única zona.

Ao remover a associação entre um intervalo e uma zona, o updateZoneKeyRange não remove a zona. Utilize o comando removeShardFromZone para remover a associação entre uma zona e um shard.

Consulte a página do manual de zonas para obter mais informações sobre zonas em clusters fragmentados.

Segurança

Para clusters fragmentados em execução com autenticação, você deve autenticar como:

• um usuário cujos privilégios incluem as ações especificadas em várias coleções no banco de dados config :

  • find na collection config.shards

  • find, update e remove na collection config.tags ;

  ou, alternativamente,

• um usuário cujos privilégios incluem enableSharding no recurso do cluster .

As roles embutidas clusterAdmin ou clusterManager updateZoneKeyRange as permissões apropriadas para emitir . Consulte a página de documentação do Controle de acesso baseado em funções para obter mais informações.

Exemplo

Dada uma collection fragmentada exampledb.collection com uma chave de shard de { a : 1 }, a operação a seguir cria uma faixa com um limite inferior de 1 e um limite superior de 10 na zona alpha :

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1 },
      max : { a : 10 },
      zone : "alpha"
   }
)

A seguinte operação remove o intervalo criado anteriormente passando null para o campo zone .

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1 },
      max : { a : 10 },
      zone : null
   }
)

Os min e max devem corresponder exatamente aos limites do intervalo alvo. A operação a seguir tenta remover o intervalo criado anteriormente, mas especifica { a : 0 } como o limite min :

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 0 },
      max : { a : 10 },
      zone : null
   }
)

Embora a faixa de { a : 0 } e { a : 10 } abranja a faixa existente, não é uma correspondência exata e, portanto, updateZoneKeyRange não remove nada.

admin = db.getSiblingDB("admin")
admin.runCommand(
   {
      updateZoneKeyRange : "exampledb.collection",
      min : { a : 1, b : 1 },
      max : { a : 10, b : 10 },
      zone : "alpha"
   }
)