AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

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

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

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

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

  • displayBatchSize から50

  • inspectDepth から20

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

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

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

オペレーティング システム
ファイルの場所

Windows

mongosh.cfg( mongosh.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
説明

browser

string またはブール値

システムのデフォルトブラウザ

MONGODB-OIDC が有効な場合に mongosh がリダイレクトするブラウザを指定します。

このオプションは、システム shell で実行されます。

開いているブラウザを完全に無効にするには、browser を false に設定します。

disableLogging

ブール値

false

MongoDB Shell がログエントリを書込むかどうかを指定します。

disableSchemaSampling

ブール値

false

デフォルトでは 、 MongoDB Shell はデータベーススキーマをサンプリングして、オートコンプリートの提案を有効にします。

この設定を true に設定すると、 MongoDB Shell はデータベーススキーマをサンプルせず、オートコンプリートはコレクションが空であるかのように動作します。

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

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

logCompressionEnabled

ブール値

false

MongoDB Shell がログファイルを圧縮するかどうかを指定します。この値が true の場合、 MongoDB Shell は gzip を使用してログを圧縮します。「 ログ圧縮の有効化 」を参照してください。

logLocation

string

オペレーティング システムによって異なります。「 shell ログの表示 」を参照してください。

MongoDB Shell がログファイルを書き込むディレクトリ。絶対ファイルパスを指定します。「 ログファイルの指定 」を参照してください。

logMaxFileCount

整数または Infinity

100

MongoDB Shell が保持するログファイルの最大数。MongoDB Shell がログファイルの最大数に達すると、カウントがしきい値を下回るまで、最も古いログファイルの削除を開始します。「 最大ログファイル数の変更 」を参照してください。

logRetentionDays

整数または Infinity

30

MongoDB Shell のログファイルが保持される日数。この値が Infinity に設定されている場合、ログファイルは経過時間に基づいて削除されません。ログストレージが大きくなりすぎるのを防ぐには、常に少なくとも 1 つのログ保持基準を指定します。「 ログの保持 」を参照してください。

logRetentionGB

浮動小数、または 無限大

設定解除

MongoDB Shell ログに使用されるスペースの最大量(ギガバイト単位)。MongoDB Shell ログの合計サイズがこの値を超えると、ログファイルは最も古いログから削除されます。

この値を Infinity に設定すると、ストレージサイズに基づいてログファイルは削除されません。ログストレージが大きくなりすぎるのを防ぐには、常に少なくとも 1 つのログ保持基準を指定します。「 ログの保持 」を参照してください。

oidcRedirectUri

string

http://localhost:27097/redirect

認証後に IdP がリダイレクトする URI を指定します。URI は IdP の構成と一致する必要があります。デフォルトは http://localhost:27097/redirect です。

oidcTrustedEndpoints

文字列の配列

[] (空の配列)

Atlas または localhost 以外の、可能なワイルドカードを含む信頼できるエンドポイントとなる接続されたデバイスのホスト名の配列を指定します。アクセス トークンはこれらのエンドポイントとなる接続されたデバイスに送信されます。信頼できるエンドポイントとなる接続されたデバイスのみを構成します。

redactHistory

string

remove

mongosh コマンド履歴に記録される情報を制御します。シェル内であれば、アップキーとダウンキーまたは Ctrl+ Rを使用して mongosh コマンドの履歴にアクセスできます。

次のいずれかの値でなければなりません。

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

  • remove: 履歴から機密コマンドを含む行を削除します。例、remove は db.auth() または connect() への呼び出しを削除します。

  • remove-redact: 機密コマンドを含む行を削除し、ファイルパス、メールアドレス、URL などの特定の文字列を他の履歴行から削除します。

showStackTraces

ブール値

false

エラー メッセージとともにスタック トレースの表示を制御します。

snippetAutoload

ブール値

true

trueの場合、起動時にインストールされたスニペットを自動的に読み込みます。

snippetIndexSourceURLs

string

スニペットレジストリにリンクする URL のセミコロン区切りリスト。

snippetRegistryURL

string

スニペット をインストールする npm クライアントが使用するmongosh npm レジストリ。

updateURL

string

https://downloads.mongodb.com/compass/mongosh.json

MongoDB Shell がスタートアップ時に利用可能な更新を確認するURLです。

更新通知と関連する送信ネットワークリクエストを無効にするには、updateURL を空の string に設定します。

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

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

  • 再起動後も永続的。

例

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

mongosh: inspectDepth: 20

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

config.set( "inspectDepth", 10 )

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