Docs Menu
Docs Home
/
MongoDBマニュアル
/
参照
/
データベース コマンド
/
管理

getParameter

項目一覧

  • 定義
  • 互換性
  • 構文
  • コマンドフィールド
  • 動作
  • 例

定義

getParameter

getParameterは、パラメータの値を取得するための管理コマンドです。 db.adminCommand( { command } )メソッドを使用して、 adminデータベースでgetParameterコマンドを実行します。

互換性

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

  • MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

重要

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

  • MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

  • MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

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

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

コマンドフィールド

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

フィールド
タイプ
説明

getParameter

int, string, document

次の値を指定します。

  • 1 （または任意の整数値）を指定して、指定された<parameter>の値を返します。

  • '*' は、getParameter で使用可能なすべてのパラメータの値を返し、<parameter> フィールドを無視します。

  • { showDetails: true } は、次を含むドキュメントを返します。

    • value、 <parameter>に設定されている値

    • settableAtRuntime、実行時に<parameter>を設定できるかどうか

    • settableAtStartup、起動時に<parameter>を設定できるかどうか

  • { showDetails: true, allParameters: true } すべてのパラメーターの show Details フィールドを含むドキュメントを返します。

  • { allParameters: true } すべてのパラメータを含むドキュメントを返します。

    • { allParameters: true, setAt: "startup" } は、スタートアップ時に設定できるすべてのパラメータを含むドキュメントを返します。

      バージョン8.0の新機能。

    • { allParameters: true, setAt: "runtime" } 実行時に設定できるすべてのパラメータを含むドキュメントを返します。

      バージョン8.0の新機能。

<parameter>

string

検索するパラメータの string 名。

<value>の値は出力に影響しません。

comment

any

任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。

コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。

動作

getParameterはadminデータベースでのみ実行され、他のデータベースで実行された場合はエラーを返します。

<parameter>に指定できる値は、使用しているバージョンとストレージ エンジンによって異なる場合があります。 使用可能なパラメータを一覧表示する例については、「すべてのパラメータを取得」を参照してください。

例

Retrieve Single Parameter

次の操作では、 saslHostNameの値を使用してadminデータベースでgetParameterを実行し、そのパラメータの値を取得します。

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

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

注意

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

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

Retrieve All Parameters

次の操作では、 '*'の値を指定してgetParameterを実行し、すべてのパラメータを検索します。

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

注意

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

Tip

以下も参照してください。

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

1 つのパラメーターの詳細を報告する

次の例では、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 } } )

Retrieve All Startup Parameters

バージョン8.0の新機能。

次の例では、すべてのスタートアップパラメータを検索するためにgetParameterコマンドを実行します。

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

Retrieve All Runtime Parameters

バージョン8.0の新機能。

次の例では、すべてのランタイム パラメータを検索するためにgetParameterコマンドを実行します。

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

戻る

getDefaultRWConcern

次へ

killCursors