Definición
balancerCollectionStatusDevuelve un documento que contiene información sobre si los fragmentos de una colección particionada están equilibrados (es decir, no necesitan ser trasladados) en el momento en que se ejecuta el comando o necesitan ser trasladados debido al drenaje de particiones, violación de la zona o desequilibrio de fragmentos entre las particiones.
Sólo puedes emitir el
balancerCollectionStatuscontra la base de datosadmin.Tip
En
mongosh, este comando también se puede ejecutar a través delsh.balancerCollectionStatus()método asistente.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.
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( { balancerCollectionStatus: "<db>.<collection>" } )
Especifique el namespace completo ("<db>.<collection>") de la colección particionada.
mongosh proporciona un método contenedor sh.balancerCollectionStatus().
Control de acceso
Al ejecutar con control de acceso, el usuario debe tener las enableSharding acciones de privilegio en base de datos y/o colección para ejecutar el comando. Es decir, un usuario debe tener un rol que conceda la siguiente privilegio:
{ resource: { db: <database>, collection: <collection> }, actions: [ "enableSharding" ] }
El rol clusterManager incorporado proporciona los privilegios apropiados.
Documento de salida
El siguiente es un ejemplo de un documento devuelto por el comando:
{ "balancerCompliant" : false, "firstComplianceViolation" : "chunksImbalance", "ok" : 1, "operationTime" : Timestamp(1583192967, 16), "$clusterTime" : { "clusterTime" : Timestamp(1583192967, 16), "signature" : { "hash" : BinData(0,"AAAAAAAAAAAAAAAAAAAAAAAAAAA="), "keyId" : NumberLong(0) } } }
Campo | Descripción |
|---|---|
| Un booleano que indica si los fragmentos no necesitan ser movidos ( |
| Una string que indica la razón por la que los fragmentos de este namespace deben ser movidos. El campo solo está disponible si Los valores posibles son:
Este campo solo devuelve información sobre la primera infracción observada por MongoDB. Puede haber migraciones de fragmentos adicionales pendientes debido a una razón diferente a la reportada en |
Además de los campos de retorno específicos del comando, el comando también devuelve el campo de estado ok, el campo operationTime y el campo $clusterTime para la operación. Para obtener detalles sobre estos campos, consulte Respuesta.
Ejemplo
Para verificar si las particiones de una colección particionada test.contacts están actualmente equilibradas, conecta a una instancia mongos y ejecuta el siguiente comando:
db.adminCommand( { balancerCollectionStatus: "test.contacts" } )
Si los fragmentos de la colección no necesitan moverse, el comando devuelve una salida similar a la siguiente:
{ "balancerCompliant" : true, "ok" : 1, "operationTime" : Timestamp(1583193238, 1), "$clusterTime" : { "clusterTime" : Timestamp(1583193238, 1), "signature" : { "hash" : BinData(0,"AAAAAAAAAAAAAAAAAAAAAAAAAAA="), "keyId" : NumberLong(0) } } }