getParameter（データベースコマンド）

定義

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.

このコマンドは、次の環境でホストされている配置で使用できます。

このコマンドは、M0 およびフレックスクラスターで限定的にサポートされています。詳細については、「サポートされていないコマンド」を参照してください。

このコマンドの構文は、次のとおりです。

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

このコマンドは、次のフィールドを使用します。

フィールド	タイプ	説明
`getParameter`	int, string, document	次の値を指定します。 `1` （または任意の整数値）を指定して、指定された`<parameter>`の値を返します。 `''` to return values for all parameters available to `getParameter`, ignoring the `<parameter>` field. `{ showDetails: true }` は、次を含むドキュメントを返します。 `value`、 `<parameter>`に設定されている値 `settableAtRuntime`、実行時に`<parameter>`を設定できるかどうか `settableAtStartup`、起動時に`<parameter>`を設定できるかどうか `{ showDetails: true, allParameters: true }` to return a document containing showDetails fields for all* parameters.
`<parameter>`	string	検索するパラメータの string 名。 `<value>`の値は出力に影響しません。
`comment`	any	任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。 `attr.command.cursor.comment` フィールド内のmongod ログメッセージ。 `command.comment` フィールドのデータベースプロファイラー出力。 `command.comment` フィールドの`currentOp`出力。コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。

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

<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 } )

このコマンドは、次の出力を返します。

出力は、MongoDB インスタンスのバージョンと特定の構成によって異なる場合があります。

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

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

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

出力は、MongoDB のバージョンと実行中の MongoDB インスタンスの特定の構成によって異なる場合があります。

setParameter これらのパラメーターの詳細については、を参照してください。

The following example runs getParameter with {showDetails: true} to report details on saslHostName.

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

出力例:

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

出力は、MongoDB インスタンスのバージョンと特定の構成によって異なる場合があります。

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

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