listShards (comando de base de datos)

Definición

listShards

The listShards command returns a list of the configured shards in a sharded cluster. listShards is only available on mongos instances and must be issued against the admin database.

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.runCommand(
  {
    listShards: 1
  }
)

Ejemplo

The following operation runs listShards against the mongos admin database:

db.adminCommand({ listShards: 1 })

The following document is an example of the output from a listShards command:

{
  "shards": [
    {
      "_id": "shard01",
      "host": "shard01/host1:27018,host2:27018,host3:27018",
      "state": 1
    },
    {
      "_id": "shard02",
      "host": "shard02/host4:27018,host5:27018,host6:27018",
      "tags": [ "NYC" ],
      "state": 1
    },
    {
      "_id": "shard03",
      "host": "shard03/host7:27018,host8:27018,host9:27018",
      "state": 1
    }
  ],
  "ok": 1,
  "$clusterTime" : {
     "clusterTime" : Timestamp(1510716515, 1),
     "signature" : {
        "hash" : BinData(0,"B2ViX7XLzFLS5Fl9XEuFXbwKIM4="),
        "keyId" : Long("6488045157173166092")
     }
  },
  "operationTime" : Timestamp(1510716515, 1)
}

Salida

listShards devuelve un documento que incluye:

• Un shards campo que contiene un arreglo de documentos, cada uno describiendo uno de las particiones. Cada documento puede contener los siguientes campos:

  Campo	Descripción
  _id	El nombre de la partición.
  host	El nombre de host de la partición. Si la partición es un set de réplicas, host enumera el nombre de host de cada instancia de mongod en el set de réplicas.
  draining	Si es verdadero, indica que removeShard (comando de base de datos) ha sido llamado para esta partición y está en proceso de ser drenado.
  tags	Una lista de zonas a las que pertenece la partición.
  state	Un campo interno utilizado durante la secuencia addShard (comando de base de datos) para garantizar que todos los pasos y la configuración necesarios para agregar la partición al clúster se realicen correctamente.

• El campo de estado ok, el campo operationTime y el campo $clusterTime para la operación. Para obtener detalles sobre estos campos, ver Response.