getParameter
getParameter
getParameter
是用于检索参数值的管理命令。使用db.adminCommand( { command } )
方法在admin
数据库中运行getParameter
命令。getParameter
命令采用以下语法:{ getParameter: <value>, <parameter> : <value>, comment: <any> } 该命令接受以下字段:
字段类型说明getParameter
整数、字符串、文档指定以下值:
1
(或任何整数值)来返回指定<parameter>
的值。'*'
返回getParameter
可用的所有参数的值,并忽略<parameter>
字段。{ showDetails: true }
,该值可返回包含以下内容的文档:value
,<parameter>
设置为这个值settableAtRuntime
,表示是否可以在运行时设置<parameter>
settableAtStartup
,是否可以在启动时设置<parameter>
{ showDetails: true, allParameters: true }
可返回包含 所有 参数的 showDetails 字段 的文档。
<parameter>
字符串要检索参数的字符串名称。
<value>
的值不影响输出。comment
任何可选。用户提供的待附加到该命令的注释。设置后,该注释将与该命令的记录一起出现在以下位置:
mongod 日志消息,位于
attr.command.cursor.comment
字段中。command.comment
字段中的数据库分析器输出。currentOp
输出,在command.comment
字段。
注释可以是任何有效的 BSON 类型(字符串、整型、对象、数组等)。
行为
getParameter
仅在admin
数据库上运行,如果在任何其他数据库上运行,则会返回错误。
<parameter>
的可能值可能会有所不同,具体取决于所使用的版本和存储引擎。有关列出可用参数的示例,请参阅检索所有参数。
举例
检索单个参数
以下操作使用值saslHostName
在admin
数据库上运行getParameter
,以检索该参数的值:
db.adminCommand( { getParameter : 1, "saslHostName" : 1 } )
该命令返回以下输出:
注意
根据 MongoDB 实例的具体配置,输出可能有所不同。
{ "saslHostName" : "www.example.net:27018", "ok" : 1 }
检索所有参数
以下操作运行值为'*'
getParameter
检索所有参数:
db.adminCommand( { getParameter : '*' } )
注意
根据 MongoDB 的版本和运行 MongoDB 实例的具体配置,输出可能有所不同。
报告单个参数的详情
以下示例运行带有{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 } } )