getParameter

在本页

定义

getParameter: getParameter 是一个用于检索参数值的行政命令。使用 db.adminCommand( { command } ) 方法在 admin 数据库中运行 getParameter 命令。db.adminCommand( { command } ) 方法来运行 getParameter 命令。

此命令在以下环境中的部署中可用

该命令在M0、M2和M5集群中支持有限。有关更多信息，请参阅不受支持的命令。

该命令具有以下语法

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

该命令包含以下字段

字段	类型	描述
`getParameter`	int, string, document	指定值 `1`（或任何整数值）以返回指定`<parameter>`的值。 `''`以返回所有可用参数的值，忽略`<parameter>`字段。 `{ showDetails: true }`以返回包含以下内容的文档 `value`，`<parameter>`设置的值 `settableAtRuntime`，是否可以在运行时设置`<parameter>` `settableAtStartup`，是否可以在启动时设置`<parameter>` `{ showDetails: true, allParameters: true }` 将返回包含 showDetails 字段的文档，用于显示所有参数。 `{ allParameters: true }` 将返回包含所有参数的文档。 `{ allParameters: true, setAt: "startup" }` 将返回包含您可以在启动时设置的所有参数的文档。新功能在版本8.0. `{ allParameters: true, setAt: "runtime" }` 将返回包含您可以在运行时设置的所有参数的文档。新功能在版本8.0*.
`<parameter>`	字符串	要检索的参数的字符串名称。 `<value>` 的值不影响输出。
`注释`	任意类型	可选。用户提供的注释，用于附加到此命令。一旦设置，此注释将出现在以下位置的此命令记录旁边 mongod 日志消息中的 `attr.command.cursor.comment` 字段。数据库分析器输出，在 `command.comment` 字段。 `currentOp` 输出，在 `command.comment` 字段。注释可以是任何有效的 BSON 类型（字符串、整数、对象、数组等）。

getParameter 仅在 admin 数据库上运行，如果在其他数据库上运行则返回错误。

<parameter> 的可能值可能取决于所使用的版本和存储引擎。有关列出可用参数的示例，请参阅检索所有参数。

以下操作在 admin 数据库上运行 getParameter，使用 saslHostName 的值来检索该参数的值

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

命令返回以下输出

输出可能因您的 MongoDB 实例的版本和具体配置而有所不同。

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

以下操作使用值 '*' 运行 getParameter 以检索所有参数

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

输出可能因 MongoDB 的版本和正在运行的 MongoDB 实例的具体配置而有所不同。

setParameter 了解有关这些参数的更多信息。

以下示例运行 getParameter 并使用 {showDetails: true} 来报告关于详细信息的 saslHostName。

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

示例输出

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

输出可能因您的 MongoDB 实例的版本和具体配置而有所不同。

以下示例运行 getParameter 并使用 {showDetails: true, allParameters: true} 来报告所有参数的详细信息。

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

新功能在版本8.0.

以下示例运行 getParameter 命令以检索所有启动参数

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

新功能在版本8.0.

以下示例运行 getParameter 命令以检索所有运行时参数

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

getDefaultRWConcern

killCursors