getParameter (comando de base de datos)

Definición

getParameter: getParameteres un comando administrativo para recuperar los valores de los parámetros. Utilice el métododb.adminCommand( { command } )para ejecutar el comandogetParameteren la base de datos admin.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Importante

Este comando tiene soporte limitado en los clústeres Flex y M0. Para obtener más información, consulta Comandos no compatibles.

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

El comando tiene la siguiente sintaxis:

db.adminCommand(
   {
     getParameter: <value>,
     <parameter> : <value>,
     comment: <any>
   }
)

Campos de comandos

El comando toma los siguientes campos:

Campo	Tipo	Descripción
`getParameter`	int, string, documento	Especifica un valor de: `1` (o cualquier valor entero) para devolver el valor para el `<parameter>` especificado. `''` para devolver valores para todos los parámetros disponibles para, ignorando `getParameter` el `<parameter>` campo. `{ showDetails: true }` para devolver un documento que contenga: `value`el valor que se establece para `<parameter>` `settableAtRuntime`, tanto si `<parameter>` puede o no establecerse en tiempo de ejecución `settableAtStartup`, si se puede establecer `<parameter>` o no en el arranque `{ showDetails: true, allParameters: true }` para devolver un documento que contenga campos showDetails para todos los* parámetros. `{ allParameters: true }` para devolver un documento que contenga todos los parámetros. `{ allParameters: true, setAt: "startup" }` para devolver un documento que contenga todos los parámetros que se pueden establecer al inicio. Nuevo en la versión 8.0. `{ allParameters: true, setAt: "runtime" }` para devolver un documento que contenga todos los parámetros que puedes definir en tiempo de ejecución. Nuevo en la versión 8.0.
`<parameter>`	string	string name of the parameter to recuperar. El valor de `<value>` no afecta la salida.
`comment`	any	Opcional. Un comentario proporcionado por el usuario para adjuntar a este comando. Una vez configurado, este comentario aparece junto a los registros de este comando en las siguientes ubicaciones: Mensajes de registro de mongod, en el campo `attr.command.cursor.comment`. Salida del perfilador de base de datos, en el campo `command.comment`. `currentOp` de salida, en el campo `command.comment`. Un comentario puede ser de cualquier tipo BSON válido (string, objeto, arreglo, etc.).

Comportamiento

getParameter se ejecuta únicamente en la admin base de datos y devuelve un error si se ejecuta en cualquier otra base de datos.

El valor posible para <parameter> puede variar dependiendo de la versión y el motor de almacenamiento en uso. Consulta Recuperar todos los parámetros para un ejemplo de cómo listar los parámetros disponibles.

Ejemplos

Retrieve Single Parameter

La siguiente operación ejecuta en getParameter la admin base de datos utilizando un valor de saslHostName para recuperar el valor de ese parámetro:

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

El comando devuelve la siguiente salida:

Nota

La salida puede variar dependiendo de la versión y configuración específica de tu instancia de MongoDB.

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

Retrieve All Parameters

La siguiente operación ejecuta con un valor getParameter de '*' para recuperar todos los parámetros:

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

Nota

La salida puede variar dependiendo de la versión de MongoDB y la configuración específica de la instancia de MongoDB en funcionamiento.

Tip

setParameter para obtener más información sobre estos parámetros.

Detalles del Informe sobre un Solo Parámetro

El siguiente ejemplo ejecuta getParameter con {showDetails: true} para informar detalles saslHostNamesobre.

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

Ejemplo de salida:

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

Nota

La salida puede variar dependiendo de la versión y configuración específica de tu instancia de MongoDB.

Detalles del informe para todos los parámetros

El siguiente ejemplo ejecuta getParameter con {showDetails: true, allParameters: true} para informar detalles sobre todos los parámetros.

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

Retrieve All Startup Parameters

Nuevo en la versión 8.0.

El siguiente ejemplo ejecuta el comando para recuperar todos los parámetros de getParameter inicio:

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

Retrieve All Runtime Parameters

Nuevo en la versión 8.0.

El siguiente ejemplo ejecuta el getParameter comando para recuperar todos los parámetros de tiempo de ejecución:

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

Volver

getDefaultRWConcern

killCursors