起動時に構成ファイルを使用して、MongoDB Compass 設定をカスタマイズできます。 Compass インターフェース上の 構成ファイル を使用して設定された設定を上書きすることはできません。
構成ファイルのロケーション
macOS と Linux の場合、構成ファイルは/etc/mongodb-compass.confにあります。
Windowsの場合、構成ファイルはCompass実行可能ファイルの親フォルダーにあります。使用した インストーラーに基づいて、次の例を検討します。
Compass を
.exeファイルとしてインストールし、かつ Compass のインストールがC:\Users\Administrator\AppData\Local\MongoDBCompass\app-1.47.1\MongoDBCompassにある場合、構成ファイルはC:\Users\Administrator\AppData\Local\MongoDBCompass\app-1.47.1\mongodb-compass.cfgにあります。注意
.exeインストーラーを使用するインストールの場合、 MongoDB Compass の実行可能ファイルと構成ファイルのパスにはバージョン番号が含まれます。Compass を
.msiファイルとしてインストールし、かつ Compass のインストールがC:\Program Files\MongoDB Compassにある場合、構成ファイルはC:\Program Files\mongodb-compass.cfgに配置されます。Compass を
.zipファイルとしてインストールした場合、構成ファイルは Compass を解凍した親フォルダーにあります。
構文
Compass の構成ファイル設定は、EJSON または YAML 形式で構成できます。
EJSON
{ "setting": value, "setting": value, ...}YAML
setting option: valuesetting option: value設定
設定 | 定義 |
|---|---|
autoUpdates | Compass で新しいアップデートを定期的にチェックできるようにします。 |
enableAtlasSignIn | ユーザーが Atlas アカウントにサインインし、クラスターとデータにアクセスできるようにします。デフォルトは この設定は、構成ファイルでのみ設定できます。Compass インターフェースまたはコマンドラインからは設定できません。 |
Compass が自然言語クエリに生成系AIを使用できるようにします | |
enablegenAISampleDocumentPassing | MongoDB Compass がクエリおよび集計生成リクエストでサンプルフィールド値を送信できるようにします。 これらの値により、 AIの結果を改善することができます。
|
Compass で Chrome DevTools を有効にします。 | |
enableMaps | Compass がサードパーティのマッピング サービスにリクエストをできるようにします。 |
Compass に埋め込まれた MongoDB Shell を有効または無効にします。 | |
Compass 経由で MongoDB 配置に接続するときに、 に接続オプション値を割り当てます。 これらの接続オプションは、 Compassインターフェースまたは コマンドラインの接続stringからの接続では上書きできません。 | |
無視追加CommandLineFlags | 追加のコマンドライン オプション フラグを許可または禁止します。 |
insertURLHandlers | CompassをMongoDB :// およびMongoDB +srv:// URL のハンドラーとして登録します。 Install Compass as URL Protocol Handler が有効になっている場合は、インターネット ブラウザーで mongodb:// または mongodb+srv:// URL にアクセスすることで Compass を開くことができます。 macOS および Windows で利用できます。 |
maxTimeMS | すべての Compass データベース操作の上限を指定します。 |
MongoDB Compass が データベースに対する操作以外の送信ネットワーク操作を実行しないようにします。 | |
すべての接続文字列を読み取り専用として設定します。 接続文字列内のパスワードは
| |
protectConnectionStringsForNewConnections | 新しい接続の接続文字列をデフォルトで読み取り専用として設定します。 新しい接続文字列内のパスワードは
|
プロキシ | 配置に接続するためのプロキシの使用を指定または強制することができます。プロキシを使用して配置に接続する方法の詳細については、「 プロキシ/SSH トンネル接続タブ 」を参照してください。 URLまたは次の形式 のいずれかを渡す必要があります。
|
Compass を通じて MongoDB 配置への書込み操作がユーザーに実行されるのを防ぎます。 詳細については、「 MongoDB への書込み操作の制限 」を参照してください。 | |
Compass 接続フォームで Kerberos のパスワード フィールドを表示または非表示にします。 詳細については、「 Kerberos パスワード フィールドの表示 」を参照してください。 | |
テーマ | MongoDB Compass UI のテーマを指定します。 サポートされているテーマは、 |
trackUsageStatistics | Compass が匿名の使用状況統計を送信できるようにします。 詳細については、「 テレメトリオプションの構成 」を参照してください。 |
注意
利用可能なすべての Compass 構成オプションを表示するには、MongoDB Compass 実行可能ファイルを含むフォルダーで次のコマンドを実行します。
<path-to-Compass-executable> --help例
Compass のサンプル構成ファイルを表示するには、次のコマンドを実行します。
<path-to-Compass-executable> --show-example-config構成ファイルがまだない場合は、次のコマンドを実行してサンプル構成設定を使用する構成ファイルを作成します。
<path-to-Compass-executable> --show-example-config > /etc/mongodb-compass.conf