updateZoneKeyRange (comando de base de datos)

Definición

updateZoneKeyRange

La updateZoneKeyRange El comando administrativo puede crear o remover la asociación entre un rango de valores de clave de partición y un 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

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

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 addShardToZone en la base de datos admin.

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 asistentes:

• 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 puedes crear un rango de valores de la clave de partición cuyos límites inferior y superior se superpongan con un rango existente para la colección particionada. Por ejemplo, dado un **rango** existente de 1 a 10, no puede crear un nuevo **rango** de 5 a 20, ya que el nuevo **rango** se superpondría con el **rango** existente.

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

Al remover la asociación entre un rango y una zona, updateZoneKeyRange no remueve la zona. Usa el comando removeShardFromZone para remover la asociación entre una zona y una partición.

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

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 colección config.shards

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

  o, alternativamente,

• un usuario cuyos privilegios incluyan enableSharding sobre el recurso clúster.

Las clusterAdmin o clusterManager roles integradas tienen los permisos adecuados para emitir updateZoneKeyRange. Consulta la página de documentación sobre Control de Acceso Basado en Roles para obtener más información.

Ejemplo

Dada una colección particionada exampledb.collection con una clave de partición { 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 anteriormente al pasar null al campo zone.

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

El min y el max deben coincidir exactamente con los límites del rango objetivo. La siguiente operación intenta remover 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"
   }
)