updateZoneKeyRange (comando de base de datos)

Definición

updateZoneKeyRange

El comando administrativo puede crear o eliminar la asociación entre un rango de valores de clave de fragmento y updateZoneKeyRange una zona.

Puede ejecutar el comando de base de datos updateZoneKeyRange y sus asistentes sh.updateZoneKeyRange() y sh.addTagRange() en una colección no particionada o en una colección inexistente.

Tip

mongoshEn, este comando también se puede ejecutar a través del método sh.updateZoneKeyRange() auxiliar.

Los métodos asistente son convenientes para usuarios de mongosh, pero es posible que no proporcionen el mismo nivel de información que los comandos de base de datos. En los casos en que no se necesite la conveniencia o se requieran campos de retorno adicionales, utiliza el comando de base de datos.

Para ejecutar updateZoneKeyRange, utiliza el método db.runCommand( { <command> } ).

Debe ejecutar en la base de datos de addShardToZone administración.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

El comando tiene la siguiente sintaxis:

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

Campos de comandos

El comando toma los siguientes campos:

Comportamiento

Si ningún rango de zona coincide con los límites mínimo y máximo pasados a updateZoneKeyRange, no se elimina nada.

Solo emite updateZoneKeyRange cuando estés conectado a una instancia mongos.

mongosh proporciona dos métodos auxiliares:

• sh.updateZoneKeyRange() para agregar un rango de valores de clave de fragmento a una zona.

• sh.removeRangeFromZone() para eliminar un rango de valores de clave de fragmento de una zona.

No se puede crear un rango de valores de clave de fragmento cuyos límites inferior y superior se superpongan con un rango existente para la colección fragmentada. Por ejemplo, dado un rango existente de 1 a 10, no se puede crear un nuevo rango de 5 a 20, ya que este se superpondría con el rango existente.

Una zona puede tener varios rangos de datos asociados a ella, pero un rango puede estar asociado, como máximo, a una sola zona.

Al eliminar la asociación entre un rango y una zona, no eliminaupdateZoneKeyRange removeShardFromZone la zona. Utilice el comando para eliminar la asociación entre una zona y un fragmento.

Consulte la página del manual de zonas para obtener más información sobre las zonas en clústeres fragmentados.

Seguridad

Para los clústeres fragmentados que se ejecutan con autenticación, debe autenticarse como:

• un usuario cuyos privilegios incluyen las acciones especificadas en varias colecciones en la base de datos config:

  • find en la config.shards colección

  • find, update y en remove la config.tags colección;

  o, alternativamente,

• un usuario cuyos privilegios incluyen en enableSharding el recurso del clúster.

Los roles clusterAdmin integrados o clusterManager tienen los permisos adecuados para updateZoneKeyRange emitir. Consulte la página de documentación sobre el control de acceso basado en roles para obtener más información.

Ejemplo

Dada una colección fragmentada exampledb.collection con una clave de fragmento de { a : 1 }, la siguiente operación crea un rango con un límite inferior de 1 y un límite superior de 10 en la zona alpha:

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

La siguiente operación elimina el rango creado previamente pasando null al campo zone.

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

Los valores min y max deben coincidir exactamente con los límites del rango objetivo. La siguiente operación intenta eliminar el rango creado previamente, pero especifica { a : 0 } como el límite min:

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

Si bien el rango de { a : 0 } y { a : 10 } abarca el rango existente, no es una coincidencia exacta y, por lo tanto, no elimina updateZoneKeyRange nada.

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