Docs 菜单
Docs 主页
/
MongoDB Manual
/ / /

getParameter

在此页面上

  • 定义
  • 兼容性
  • 语法
  • 命令字段
  • 行为
  • 示例
getParameter

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

此命令可用于以下环境中托管的部署:

  • MongoDB Atlas:用于云中 MongoDB 部署的完全托管服务

重要

此命令在 M 0 、 M 2和 M 5集群中提供有限支持。 有关更多信息,请参阅不支持的命令。

该命令具有以下语法:

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

该命令接受以下字段:

字段
类型
说明
getParameter
整数、字符串、文档

指定以下值:

  • 1 (或任何整数值)来返回指定 <parameter> 的值。

  • '*' 返回getParameter可用的所有参数的值,并忽略<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> 的值不影响输出。

comment
any

可选。用户提供的待附加到该命令的注释。设置后,该注释将与该命令的记录一起出现在以下位置:

注释可以是任何有效的 BSON 类型(字符串、整型、对象、数组等)。

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

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

以下操作使用值saslHostNameadmin数据库上运行getParameter ,以检索该参数的值:

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

该命令返回以下输出:

注意

根据 MongoDB 实例的具体配置,输出可能有所不同。

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

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

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

注意

根据 MongoDB 的版本和运行 MongoDB 实例的具体配置,输出可能有所不同。

提示

另请参阅:

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

以下示例运行带有{showDetails: true}getParameter } 以报告有关saslHostName的详细信息。

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

示例输出:

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

注意

根据 MongoDB 实例的具体配置,输出可能有所不同。

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

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