Menu Docs
Página inicial do Docs
/
Manual do MongoDB
/
Referência
/
Comandos de banco de dados
/
Comandos de Administração

Obter parâmetro

Nesta página

  • Definição
  • 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 dados do admin .

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.

<parameter>
string

Nome da string do parâmetro a ser recuperado.

O valor para <value> não afeta o resultado.

comment
qualquer

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:

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

Recuperar parâmetro único

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 }

Recuperar todos os parâmetros

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 } } )
← getDefaultRWConcern
matarCursores →

Nesta página