getClusterParameter (comando de banco de dados)

Definição

getClusterParameter

getClusterParameter is an administrative command for retrieving the values of cluster parameters. Cluster parameters are configurable parameters that affect all nodes in a sharded cluster.

Para executar getClusterParameter , use o método db.adminCommand( { command } ) .

The getClusterParameter command is only available in self-managed installations. The getClusterParameter command is not available in MongoDB Atlas.

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.adminCommand(
   {
     getClusterParameter: <parameter> | [<parameter>, <parameter>] | "'*'"
   }
)

Campos de comando

O comando utiliza os seguintes campos:

Campo	Tipo	Descrição
`<parameter>`	string ou matriz de strings	Você pode especificar uma das seguintes opções: O nome do parâmetro que você deseja recuperar. Uma array com os nomes de vários parâmetros. `'*'`, para retornar valores para todos os parâmetros disponíveis para `getClusterParameter` .

Comportamento

Você só pode executar getClusterParameter no reconhecimento de data center admin . Se você executar o comando em qualquer outro reconhecimento de data center, o MongoDB retornará um erro.
Você pode executar getClusterParameter em qualquer nó em um conjunto de réplicas ou cluster fragmentado.
Quando você executa getClusterParameter em mongod, getClusterParameter retorna valores de parâmetro em cache.
Ao executar getClusterParameter em mongos , getClusterParameter retorna o valor durável do parâmetro cluster do servidor de configuração.

Controle de acesso

Quando a autenticação está habilitada, o getClusterParameter só funciona quando autenticado como um usuário com um role que tem acesso à ação getClusterParameter .

Exemplos

Observação

A saída dos exemplos a seguir pode variar dependendo da configuração específica da execução do deployment do MongoDB.

Recuperar parâmetro de cluster único

A operação a seguir executa getClusterParameter no banco de dados admin usando um valor de hostName para recuperar o valor de um parâmetro de cluster hipotético chamado hostName :

use admin
db.adminCommand( { getClusterParameter : "hostName" } )

Recuperar vários parâmetros de cluster

A operação a seguir executa getClusterParameter no banco de dados admin usando os valores hostName e testParameter para recuperar os valores dos parâmetros do cluster hipotético chamados hostName e testParameter :

use admin
db.adminCommand( { getClusterParameter: [ "hostName", "testParameter" ] } )

Recuperar todos os parâmetros do cluster

A seguinte operação executa o getClusterParameter com um valor de '*' para recuperar os valores de todos os parâmetros do cluster:

use admin
db.adminCommand( { getClusterParameter : '*' } )

Dica

setClusterParameter para saber mais sobre esses parâmetros.

Voltar

getAuditConfig

getDefaultRWConcern