Docs Menu
Docs Home
/
MongoDB Shell
/ /

構成ファイルを使用して設定を構成する

項目一覧

  • 構成ファイル形式
  • 構成ファイルのロケーション
  • 構成可能な設定
  • config APIによる動作

グローバル構成ファイルで mongosh設定を指定できます。 構成ファイルで設定を指定すると、それらの設定はスタートアップ時に適用されます。 構成ファイルを作成すると、次にmongoshを起動するときにファイル内の設定が有効になります。

mongoshの構成ファイルは YAML 形式を使用します。 すべてのオプションはmongosh名前空間の下にあります。

次の構成ファイルを設定します。

  • displayBatchSize から50

  • inspectDepth から20

  • redactHistory 次の行動をします: remove-redact

mongosh:
displayBatchSize: 50
inspectDepth: 20
redactHistory: "remove-redact"

mongoshが構成ファイルを検索するファイルの場所は、オペレーティング システムによって異なります。

オペレーティング システム
ファイルの場所
Windows
mongosh.cfgmongosh.exeバイナリと同じディレクトリ内)
MacOS

mongosh は、次のディレクトリ内の構成ファイルを登録されている順序で検索します。

  1. /usr/local/etc/mongosh.conf

  2. /opt/homebrew/etc/mongosh.conf

  3. /etc/mongosh.conf

mongoshがこれらのディレクトリのいずれかの構成ファイルを読み取ると、リスト内の残りのディレクトリはチェックされず、それらのディレクトリ内の構成ファイルは無視されます。

Linux
/etc/mongosh.conf

構成ファイルで、次のmongosh設定を指定できます。

キー
タイプ
default
説明
displayBatchSize
integer
20
カーソルの反復ごとに表示される項目の数
enableTelemetry
ブール値
true
匿名化された追跡データと診断データの MongoDB への送信を有効にします。
editor
string
null
mongoshコンソール内で使用するエディターを指定します。 設定されている場合は、 EDITOR環境変数を上書きします。
forceDisableTelemetry
ブール値
false
グローバル構成ファイルでのみ利用可能です。 true の場合、ユーザーは テレメトリ を手動で有効にすることはできません。
historyLength
integer
1000
mongosh REPL の履歴ファイルに保存するアイテムの数。
inspectCompact
整数またはブール値
3

mongoshが単一行に出力する内部要素のレベル。 短い配列要素も 1 行にまとめられています。

falseに設定すると、 mongoshは各フィールドを別個の行に出力します。

inspectDepth
整数または Infinity
6
オブジェクトが出力される深度。 inspectDepthInfinity( JavaScriptオブジェクト)に設定すると、ネストされたすべてのオブジェクトが完全な深度に出力されます。
redactHistory
string
remove

shell 履歴に記録される情報を制御します。 次のいずれかである必要があります。

  • keep: すべての履歴を保持します。

  • remove: 機密情報を含む行は削除します。

  • remove-redact: 機密情報を編集します。

showStackTraces
ブール値
false
エラー メッセージとともにスタック トレースの表示を制御します。
snippetAutoload
ブール値
true
trueの場合、起動時にインストールされたスニペットを自動的に読み込みます。
snippetIndexSourceURLs
string
MongoDB リポジトリ
スニペットレジストリにリンクする URL のセミコロン区切りリスト。
snippetRegistryURL
string
スニペット をインストールする npm クライアントが使用するmongosh npm レジストリ。

コンフィギュレーション API で指定される設定:

  • 構成ファイルで指定された設定を上書きします。

  • 再起動後も永続的。

inspectDepth設定を20に設定する次の構成ファイルを検討します。

mongosh:
inspectDepth: 20

mongosh セッション中に次のコマンドを実行して、inspectDepth10 に設定します。

config.set( "inspectDepth", 10 )

の値はinspectDepth 1010になり、mongosh が再起動しても のままになります。

戻る

APIの使用