/ /

Replicación

Docs Home

Desarrollo

Comandos de base de datos

Replicación

Docs Home

Desarrollo

Comandos de base de datos

Replicación

hello (comando de base de datos)

Definición

hello

Nuevo en la versión 4.2.

hello devuelve un documento que describe la función del Instancia mongod. Si se especifica el campo opcional saslSupportedMechs, el comando también devuelve un array of SASL mechanisms utilizado para crear las credenciales del usuario especificado.

Si la instancia es miembro de un conjunto de réplicas, entonces hello devuelve un subconjunto de la configuración y el estado del conjunto de réplicas, incluido si la instancia es o no la principal del conjunto de réplicas.

Cuando se envía a una instancia mongod que no es nodo de un set de réplicas, hello devuelve un subconjunto de esta información.

MongoDB drivers y clientes usan hello para determinar el estado de los miembros del set de réplicas y descubrir otros miembros de un set de réplicas.

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

Nota

Este comando es compatible con todos los clústeres de MongoDB Atlas. Para obtener información sobre el soporte de Atlas para todos los comandos, consulte Comandos no compatibles.

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(
   {
     hello: 1
   }
)

El comando hello acepta los campos opcionales saslSupportedMechs: <db.user> para devolver un campo adicional hello.saslSupportedMechs en su resultado y comment <any> para añadir un comentario de registro asociado al comando.

db.runCommand(
   {
     hello: 1,
     saslSupportedMechs: "<db.username>",
     comment: <any>
   }
)

El método db.hello() en mongosh proporciona un contenedor en torno a hello.

Comportamiento

Desconexión del cliente

Si el cliente que emitió hello se desconecta antes de que la operación se complete, MongoDB marca hello para su terminación usando killOp.

Salida

Todas las instancias

Los siguientes campos son comunes a todos los hello roles:

hello.isWritablePrimary

Un valor booleano que informa cuando este nodo es escribible. Si true, entonces esta instancia es una primaria en un set de réplicas, o una instancia mongos, o una instancia autónomo mongod.

Este campo será false si la instancia es un miembro secundario de un set de réplicas o si el miembro es un árbitro de un set de réplicas.

hello.topologyVersion: Para uso interno de MongoDB.

hello.maxBsonObjectSize: El tamaño máximo permitido de un objeto BSON en bytes para este proceso. Si no se proporciona, los clientes deben asumir un tamaño máximo de mongod "16 * 1024 * 1024".

hello.maxMessageSizeBytes: El tamaño máximo permitido de un mensaje del protocolo de conexión BSON. El valor por defecto es 48000000 bytes.

hello.maxWriteBatchSize

El número máximo de operaciones de escritura permitidas en un lote de escritura. Si un lote supera este límite, el controlador del cliente lo divide en grupos más pequeños, cada uno con recuentos menores o iguales al valor de este campo.

El valor de este límite es 100,000 escrituras.

hello.localTime: Devuelve la hora del servidor local en UTC. Este valor es una fecha ISO.

hello.logicalSessionTimeoutMinutes

El tiempo en minutos que una sesión permanece activa después de su uso más reciente. Las sesiones que no hayan recibido una nueva operación de lectura/guardado del cliente o que no se hayan actualizado con refreshSessions dentro de este umbral se eliminan de la caché. El servidor puede limpiar el estado asociado a una sesión caducada en cualquier momento.

Solo disponible cuando featureCompatibilityVersion es "3.6" o superior.

hello.connectionId: Un identificador para la conexión saliente de la instancia mongod / mongos con el cliente.

hello.minWireVersion

La versión más temprana del protocolo de conexión que esta mongod o mongos instancia es capaz de utilizar para comunicarse con los clientes.

Los clientes pueden usar minWireVersion para ayudar a negociar la compatibilidad con MongoDB.

hello.maxWireVersion

La última versión del protocolo de conexión que esta mongod o mongos instancia es capaz de utilizar para comunicarse con los clientes.

Los clientes pueden usar maxWireVersion para ayudar a negociar la compatibilidad con MongoDB.

hello.readOnly: Un valor booleano que, cuando true es, indica que mongod o se está ejecutando en modo de solo mongos lectura.

hello.compression

Una matriz que enumera los algoritmos de compresión utilizados o disponibles para su uso (es decir, comunes tanto para el cliente como para la mongod mongos instancia o) para comprimir la comunicación entre el cliente y la instancia mongod mongos o.

El campo solo está disponible si se utiliza la compresión. Por ejemplo:

Si el mongod está habilitado para usar ambos compresores snappy,zlib y un cliente ha especificado zlib, el campo compression contendría:
```
"compression": [ "zlib" ]
```
Si el mongod está habilitado para usar ambos compresores snappy,zlib y un cliente ha especificado zlib,snappy, el campo compression contendría:
```
"compression": [ "zlib", "snappy" ]
```
Si el está habilitado para usar mongod el snappy compresor y un cliente ha zlib,snappy especificado, el campo compression contendrá:
```
"compression": [ "snappy" ]
```
Si el mongod tiene habilitado el uso del compresor snappy y un cliente ha especificado zlib o el cliente no ha especificado ningún compresor, el campo se omite.

Es decir, si el cliente no especifica compresión o si el cliente especifica un compresor no habilitado para la mongod conectada o la instancia de mongos, el campo no se devuelve.

hello.saslSupportedMechs

Una serie de mecanismos SASL utilizados para crear las credenciales del usuario. Los mecanismos SASL compatibles son:

GSSAPI
SCRAM-SHA-256
SCRAM-SHA-1

El campo solo se devuelve cuando se ejecuta el comando con el campo saslSupportedMechs:

db.runCommand( { hello: 1, saslSupportedMechs: "<db.username>" } )

Instancias fragmentadas

Las instancias mongos agregan el siguiente campo al documento de respuesta de hello:

hello.msg: Contiene el valor isdbgrid cuando hello retorna de una instancia de mongos.

Sets de réplicas

hello contiene estos campos cuando lo devuelve un miembro de un conjunto de réplicas:

hello.hosts

Una matriz de cadenas en el formato "[hostname]:[port]" que enumera todos los miembros del conjunto de réplicas que no son ocultos, pasivosni árbitros.

Los controladores utilizan esta matriz y para determinar qué miembros hello.passives leer.

hello.setName: El nombre del set de réplicas actual.

hello.setVersion: La versión de configuración del conjunto de réplicas actual.

hello.secondary: Un valor booleano que, cuando es true, indica si el mongod es un miembro secundario de un set de réplicas.

hello.passives

Un arreglo de strings en el formato de "[hostname]:[port]" listando todos los nodos del set de réplicas que tienen un members[n].priority de 0.

Este campo solo aparece si hay al menos un nodo con un members[n].priority de 0.

Los controladores utilizan esta matriz y para determinar qué miembros hello.hosts leer.

hello.arbiters

Un arreglo de cadenas en formato "[hostname]:[port]" que enumera todos los miembros del set de réplicas que son árbitros.

Este campo solo aparece si hay al menos un árbitro en el set de réplicas.

hello.primary: Una string en el formato de "[hostname]:[port]" que enumera el primario miembro del set de réplicas.

hello.arbiterOnly: Un valor booleano que, cuando es true, indica que la instancia actual es un árbitro. El campo arbiterOnly solo está presente si la instancia es un árbitro.

hello.passive: Un valor booleano que, cuando es true, indica que la instancia actual es pasiva. El campo passive solo está presente para los miembros con un members[n].priority de 0.

hello.hidden: Un valor booleano que, cuando true, indica que la instancia actual está oculta. El campo hidden solamente está presente para miembros ocultos.

hello.tags

Un documento tags contiene pares de campo de etiqueta y valor definidos por el usuario para el set de réplicas.

{ "<tag1>": "<string1>", "<tag2>": "<string2>",... }

Para las operaciones de lectura, se puede especificar un conjunto de etiquetas en la preferencia de lectura para dirigir las operaciones a los miembros del set de réplicas con las etiquetas especificadas.
Para las operaciones de escritura, puede crear una preocupación de escritura personalizada utilizando settings.getLastErrorModes settings.getLastErrorDefaultsy.

Para obtener más información, consultar Configurar conjuntos de etiquetas del set de réplicas.

Tip

members[n].tags

hello.me: El [hostname]:[port] del nodo que devolvió hello.

hello.electionId: Un identificador único para cada elección. Se incluye solo en la salida de hello para la primaria. Es utilizado por los clientes para determinar cuándo ocurren las elecciones.

hello.lastWrite

Un documento que contiene optime e información de fecha para la operación de guardar más reciente de la base de datos.

hello.lastWrite.opTime: Un objeto que proporciona el tiempo óptimo de la última operación de escritura.

hello.lastWrite.lastWriteDate: Un objeto de fecha que contiene la hora de la última operación de escritura.

hello.lastWrite.majorityOpTime: Un objeto que proporciona el optime de la última operación de escritura legible por majority lecturas.

hello.lastWrite.majorityWriteDate: Un objeto de fecha que contiene la hora de la última operación de guardado legible por majority lecturas.

Para obtener detalles sobre el campo de estado ok, el campo operationTime y el campo $clusterTime, consulte Respuesta del comando.

Volver

applyOps

replSetAbortPrimaryCatchUp