olá (comando de banco de dados)

Definição

hello

Novidades na versão 4.2.

hello returns a document that describes the role of the mongod instance. If the optional field saslSupportedMechs is specified, the command also returns an array of SASL mechanisms used to create the specified user's credentials.

If the instance is a member of a replica set, then hello returns a subset of the replica set configuration and status including whether or not the instance is the primary of the replica set.

When sent to a mongod instance that is not a member of a replica set, hello returns a subset of this information.

MongoDB drivers and clients use hello to determine the state of the replica set members and to discover additional members of a replica set.

Compatibilidade

Esse comando está disponível em implantações hospedadas nos seguintes ambientes:

MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Observação

This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Sintaxe

O comando tem a seguinte sintaxe:

db.runCommand(
   {
     hello: 1
   }
)

The hello command accepts optional fields saslSupportedMechs: <db.user> to return an additional field hello.saslSupportedMechs in its result and comment <any> to add a log comment associated with the command.

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

The db.hello() method in mongosh provides a wrapper around hello.

Comportamento

Desconexão do cliente

If the client that issued hello disconnects before the operation completes, MongoDB marks hello for termination using killOp.

Saída

Todas as instâncias

The following hello fields are common across all roles:

hello.isWritablePrimary

Um valor booleano que relata quando este nó é gravável. Se true, essa instância será primário em um conjunto de réplicas, ou uma instância mongos, ou uma standalone mongod.

Este campo será false se a instância for um membro secundário de um conjunto de réplicas ou se o membro for um árbitro de um conjunto de réplicas.

hello.topologyVersion: Para uso interno do MongoDB.

hello.maxBsonObjectSize: O tamanho máximo permitido de um objeto BSON em bytes para este processo de mongod. Se não forem fornecidos, os clientes devem assumir um tamanho máximo de "16 * 1024 * 1024".

hello.maxMessageSizeBytes: O tamanho máximo permitido de uma BSON protocolo de fio. O valor padrão é 48000000 bytes.

hello.maxWriteBatchSize

O número máximo de operações de gravação permitidas em um lote de gravação. Se um lote exceder esse limite, o driver do cliente dividirá o lote em grupos menores cada um com contagens inferiores ou iguais ao valor deste campo.

O valor desse limite é 100,000 gravações.

hello.localTime: Retorna a hora do servidor local em UTC. Este valor é uma data ISO.

hello.logicalSessionTimeoutMinutes

O tempo em minutos em que uma sessão permanece ativa após seu uso mais recente. As sessões que não receberam uma nova operação de leitura/gravação do cliente ou foram atualizadas com refreshSessions dentro desse limite são apagadas do cache. O estado associado a uma sessão expirada pode ser limpo pelo servidor a qualquer momento.

Disponível apenas quando featureCompatibilityVersion for "3.6" ou superior.

hello.connectionId: Um identificador para a instância mongod / mongos conexão de saída da instância com o cliente.

hello.minWireVersion

A versão mais antiga do protocolo de conexão que essa instância mongod ou mongos é capaz de usar para se comunicar com clientes.

Clients may use minWireVersion to help negotiate compatibility with MongoDB.

hello.maxWireVersion

A versão mais recente do protocolo de fio que essa instância mongod ou mongos é capaz de usar para se comunicar com os clientes.

Clients may use maxWireVersion to help negotiate compatibility with MongoDB.

hello.readOnly: Um valor booleano que, quando true, indica que o mongod ou mongos está sendo executado no modo somente leitura.

hello.compression

Uma array listando os algoritmos de compressão utilizados ou disponíveis para uso (isto é, comum para tanto o cliente quanto a instância mongod ou mongos) para comprimir a comunicação entre o cliente e a instância mongod ou mongos.

O campo só estará disponível se a compactação for usada. Por exemplo:

If the mongod is enabled to use both the snappy,zlib compressors and a client has specified zlib, the compression field would contain:
"compression": [ "zlib" ]
If the mongod is enabled to use both the snappy,zlib compressors and a client has specified zlib,snappy, the compression field would contain:
"compression": [ "zlib", "snappy" ]
If the mongod is enabled to use the snappy compressor and a client has specified zlib,snappy, the compression field would contain :
"compression": [ "snappy" ]
Se o mongod estiver habilitado para utilizar o compressor snappy e um cliente especificou zlib ou o cliente não especificou nenhum compressor, o campo será omitido.

Isto é, se o cliente não especificar a compressão ou se o cliente especificar um compressor não habilitado para a instância mongod ou mongos conectada, o campo não será gerado.

hello.saslSupportedMechs

Uma array de mecanismos SASL usados para criar as credenciais ou credenciais do usuário. Os mecanismos SASL suportados são:

GSSAPI
SCRAM-SHA-256
SCRAM-SHA-1

O campo é retornado somente quando o comando é executado com o campo saslSupportedMechs:

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

Instâncias compartilhadas

mongos instances add the following field to the hello response document:

hello.msg: Contains the value isdbgrid when hello returns from a mongos instance.

Conjuntos de réplicas

hello contém estes campos quando gerado por um nó de um conjunto de réplicas:

hello.hosts

Uma série de strings no formato do "[hostname]:[port]" que lista todos os membros do conjunto de réplicas que não são oculto, passivo, nem árbitros.

Drivers use this array and the hello.passives to determine which members to read from.

hello.setName: O nome do :conjunto de réplicas atual.

hello.setVersion: A versão de configuração do conjunto de réplicas atual.

hello.secondary: Um valor booleano que, quando true, indica se o mongod é um membro secundário de um conjunto de réplicas.

hello.passives

Uma array de strings no formato de "[hostname]:[port]" listando todos os nós do conjunto de réplicas contendo um members[n].priority de 0.

Este campo só aparece se houver pelo menos um membro com um members[n].priority de 0.

Drivers use this array and the hello.hosts to determine which members to read from.

hello.arbiters

Uma array de strings no formato de "[hostname]:[port]" listando todos os membros do conjunto de réplicas que são árbitros.

Este campo só aparece se houver pelo menos um árbitro no conjunto de réplicas.

hello.primary: Uma string no formato de "[hostname]:[port]" que lista o nó primary atual do conjunto de réplicas.

hello.arbiterOnly: A boolean value that , when true, indicates that the current instance is an arbiter. The arbiterOnly field is only present, if the instance is an arbiter.

hello.passive: A boolean value that, when true, indicates that the current instance is passive. The passive field is only present for members with a members[n].priority of 0.

hello.hidden: A boolean value that, when true, indicates that the current instance is hidden. The hidden field is only present for hidden members.

hello.tags

Um documento tags contém um campo de tag definido pelo usuário e pares de valores para o membro do conjunto de réplica.

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

Para operações de leitura, você pode especificar um conjunto de tags na preferência de leitura para direcionar as operações para membros do conjunto de réplicas com as tags especificadas.
Para operações de gravação, você pode criar uma write concern personalizada utilizando settings.getLastErrorModes e settings.getLastErrorDefaults.

Para obter mais informações, consulte Configurar conjuntos de tags de conjunto de réplica.

Dica

members[n].tags

hello.me: The [hostname]:[port] of the member that returned hello.

hello.electionId: A unique identifier for each election. Included only in the output of hello for the primary. Used by clients to determine when elections occur.

hello.lastWrite

Um documento contendo informações de optime e data para a operação de gravação mais recente do banco de dados.

hello.lastWrite.opTime: Um objeto que fornece o optime da última operação de gravação.

hello.lastWrite.lastWriteDate: Um objeto de data contendo a hora da última operação de gravação.

hello.lastWrite.majorityOpTime: Um objeto que fornece o optime da última operação de gravação legível por majority leituras.

hello.lastWrite.majorityWriteDate: Um objeto de data contendo o tempo da última operação de gravação legível por leituras do majority.

Para obter detalhes sobre o campo de status ok, o campo operationTime e o campo $clusterTime, consulte Resposta do comando.

Voltar

applyOps

replSetAbortPrimaryCatchUp