getParameter

Nesta página

Definição

Compatibilidade
Sintaxe
Campos de comando
Comportamento
Exemplos

Definição

getParameter: getParameter é um comando administrativo para recuperar os valores dos parâmetros. Utilize o método db.adminCommand( { command } ) para executar o comando getParameter no banco de banco de dados do admin .

Compatibilidade

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

MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

Importante

Este comando tem suporte limitado em clusters M0, M2 e M5 . Para obter mais informações, consulte Comandos não suportados.

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(
   {
     getParameter: <value>,
     <parameter> : <value>,
     comment: <any>
   }
)

Campos de comando

O comando utiliza os seguintes campos:

Campo	Tipo	Descrição
`getParameter`	int, string, documento	Especifique um valor de: `1` (ou qualquer valor inteiro) para retornar o valor para o `<parameter>` especificado. `''` para retornar valores para todos os parâmetros disponíveis para `getParameter`, ignorando o campo `<parameter>` . `{ showDetails: true }` para devolver um documento que contenha: `value`, o valor que `<parameter>` está definido para `settableAtRuntime`, se `<parameter>` pode ser configurado no tempo de execução `settableAtStartup`, independentemente de `<parameter>` poder ou não ser definido na inicialização `{ showDetails: true, allParameters: true }` para retornar um documento contendo campos showDetails para todos os* parâmetros. `{ allParameters: true }` para retornar um documento contendo todos os parâmetros. `{ allParameters: true, setAt: "startup" }` para retornar um documento contendo todos os parâmetros que você pode definir na inicialização. Novidades na versão 8.0. `{ allParameters: true, setAt: "runtime" }` para retornar um documento contendo todos os parâmetros que você pode definir no tempo de execução. Novidades na versão 8.0.
`<parameter>`	string	Nome da string do parâmetro a ser recuperado. O valor para `<value>` não afeta o resultado.
`comment`	any	Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais: mensagens de log do mongod, no campo `attr.command.cursor.comment`. Saída do perfil do banco de dados, no campo `command.comment`. Saída de `currentOp`, no campo `command.comment`. Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc).

Comportamento

O getParameter é executado somente no banco de dados do admin e retorna um erro se for executado em qualquer outro banco de dados.

O valor possível para <parameter> pode variar dependendo da versão e do mecanismo de armazenamento em uso. Consulte Retrieve All Parameters para obter um exemplo de listagem dos parâmetros disponíveis.

Exemplos

Retrieve Single Parameter

A operação a seguir é executada getParameter no banco de dados admin usando um valor de saslHostName para recuperar o valor desse parâmetro:

db.adminCommand( { getParameter : 1, "saslHostName" : 1 } )

O comando retorna a seguinte saída:

Observação

O resultado pode variar dependendo da versão e configuração específica da sua instância MongoDB.

{ "saslHostName" : "www.example.net:27018", "ok" : 1 }

Retrieve All Parameters

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

db.adminCommand( { getParameter : '*' } )

Observação

O resultado pode variar dependendo da versão do MongoDB e da configuração específica da instância do MongoDB em execução.

Dica

Veja também:

setParameter para saber mais sobre esses parâmetros.

Detalhes do relatório sobre um único parâmetro

O exemplo a seguir executa getParameter com {showDetails: true} para relatar detalhes sobre saslHostName.

db.adminCommand( { getParameter : { showDetails: true }, "saslHostName" : 1 } )

Saída de exemplo:

{
  saslHostName: {
    value: '<hostname>',
    settableAtRuntime: false,
    settableAtStartup: true
  },
  ok: 1
}

Observação

O resultado pode variar dependendo da versão e configuração específica da sua instância MongoDB.

Detalhes do relatório para todos os parâmetros

O exemplo a seguir executa getParameter com {showDetails: true, allParameters: true} para reportar detalhes em todos os parâmetros.

db.adminCommand( { getParameter : { showDetails: true, allParameters: true } } )

Retrieve All Startup Parameters

Novidades na versão 8.0.

O exemplo a seguir executa o comando getParameter para recuperar todos os parâmetros de inicialização:

db.adminCommand( {
   getParameters: {
      allParameters: true,
      setAt: "startup"
   }
} )

Retrieve All Runtime Parameters

Novidades na versão 8.0.

O exemplo seguinte executa o comando getParameter para recuperar todos os parâmetros de tempo de execução:

db.adminCommand( {
   getParameters: {
      allParameters: true,
      setAt: "runtime"
   }
} )

Voltar

getDefaultRWConcern

matarCursores