getParameter (comando de banco de dados)

Definição

getParameter: getParameter is an administrative command for retrieving the values of parameters. Use the db.adminCommand( { command } ) method to run the getParameter command in the admin database.

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

Esse comando tem suporte limitado nos clusters M0 e Flex. Para saber mais, 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. `''` to return values for all parameters available to `getParameter`, ignoring the `<parameter>` field. `{ 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`	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

getParameter runs on the admin database only, and returns an error if run on any other database.

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

The following operation runs getParameter on the admin database using a value of saslHostName to retrieve the value for that parameter:

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

The following operation runs getParameter with a value of '*' to retrieve all parameters:

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

setParameter para saber mais sobre esses parâmetros.

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

The following example runs getParameter with {showDetails: true} to report details on 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

The following example runs getParameter with {showDetails: true, allParameters: true} to report details on all parameters.

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

Voltar

getDefaultRWConcern

matarCursores