Docs Menu

コマンドライン オプション

コマンドライン オプションを使用して MongoDB Compass をカスタマイズできます。

MongoDB Compass を起動し、コマンドラインから構成オプションを設定できます。 コマンドラインを使用して構成オプションを設定すると、オプションは起動時に設定されます。 コマンドライン オプションを使用して構成された設定は、Compass インターフェースでは変更できません。

Compass 実行可能ファイルの名前と場所は、オペレーティング システムによって異なります。

オペレーティング システム
実行ファイル名
ロケーション

Linux

mongodb-compass

このファイルは/usr/bin ディレクトリにインストールされます。

Windows

MongoDBCompass.exe

このファイルは、インストール プロセス中に選択したフォルダーにインストールされます。

MacOS

MongoDB Compass

このファイルは、アプリケーション フォルダーの下にインストールされます。

/Applications/MongoDB\ Compass.app/Contents/MacOS/MongoDB\ Compass

MongoDB Compass を起動し、構成オプションを設定するには、次の構文を使用します。

<path-to-Compass-executable> --<option>

これらのオプションは、コマンドラインでのみ設定できます。 これらのオプションは、 Settingsパネルまたは Compass 構成ファイルでは設定できません。

設定
定義
--exportConnections

お気に入りの接続をエクスポートします。

--help

MongoDB Compass オプションを表示するようになりました

--importConnections

お気に入りの接続をインポートします。

--passphrase

エクスポートされたお気に入りの接続出力ファイルを暗号化するためのパスフレーズを指定します。

インポートされたお気に入りの接続ファイルを復号化するためのパスフレーズを指定します。

--showExampleConfig

Compass 構成ファイルの例を提供します。

--trustedConnectionString

許可されていない接続stringプロパティに関する警告を表示しなくなり、自動接続が可能になります。 Compassは、コマンドラインで渡された接続stringを検査し、接続文字stringにセキュリティ上のリスクにつながる可能性のあるパラメーターが含まれているかどうかを確認します。

既知の信頼できる接続stringをCompassに渡す場合にのみ、このオプションを設定します。

--version

MongoDB Compass のバージョンを表示する。

これらのオプションは、コマンドライン、構成ファイル、またはSettingsパネルで設定できます。 コマンドラインでオプションを設定すると、 Settingsパネルの値が上書きされます。

設定
定義
--autoUpdates

自動更新を有効にする 。 自動更新を無効にするには、 --no-autoUpdatesを使用します。

--browserCommandForOIDCAuth

サーバーに接続するとき、または Atlas Cloud アカウントにログインするときに OIDC 認証用のブラウザを起動するための shell コマンドを指定します。

--enableFeedbackPanel

フィードバック パネルを有効にします。 自動更新を無効にするには、 --no-enableFeedbackPanelを使用します。

--enableDevTools

Compass で Chrome DevTools を有効にします。

詳しくは、「 Chrome DevTools を切り替える 」を参照してください。

--enableGenAIFeatures

Compass が自然言語クエリに 生成系 AI を使用できるようにします この機能には Atlas ログインと配置された Atlas クラスターが必要です。

--enableGenAISampleDocumentPassing

MongoDB Compass がクエリおよび集計生成リクエストでサンプルフィールド値を送信できるようにします。 これらの値により、 AIの結果を改善することができます。

trueの場合、このオプションは--enableGenAIFeatures オプションを暗黙的にtrue に設定します。

--enableMaps

MongoDB Compass がサードパーティのマッピング サービスにリクエストをできるようにします。 マッピングリクエストを無効にするには、 --no-enableMapsを使用します。

--enableShell

Compass に埋め込まれた MongoDB Shell を有効または無効にします。

詳細については、「埋め込み MongoDB Shell を無効にする 」を参照してください。

--file <file>

MongoDB Compass が起動すると自動的に利用可能な接続のリストを含むファイルを指定します。

--forceConnectionOptions

Compass 経由で MongoDB 配置に接続する場合、 に接続オプション値を割り当てます。 これらの接続オプションは、 Compassインターフェースまたは コマンドラインの接続stringからの接続では上書きできません。

詳しくは、「読み込み設定(read preference)とタグの指定 」を参照してください。

--ignoreAdditionalCommandLineFlags

追加のコマンドライン フラグを使用できます。

--installURLHandlers

CompassをMongoDB :// およびMongoDB +srv:// URL のハンドラーとして登録します。

Install Compass as URL Protocol Handlerが有効になっている場合は、インターネットCompass MongoDBMongoDBURLブラウザで :// または +srv:// に移動することで を開くことができます。

macOS および Windows で利用できます。

--maxTimeMS

すべての Compass データベース操作の上限を指定します。

--networkTraffic

MongoDB Compass を データベースへの送信ネットワーク操作のみを許可するように設定します。

詳細については、「送信ネットワーク接続のブロック 」を参照してください。

--password

接続 で提供されるCompass とMongoDBstring 配置への認証用パスワードを指定します。

--usernameと組み合わせて使用します。

--persistOIDCTokens

MongoDB サーバー接続に MongoDB OIDC 認証メカニズムを使用するときに、ログインしたままにできます。 セッション トークンは、システム キーチェーンを使用して暗号化され、保存されます。

--protectConnectionStrings

すべての接続文字列を読み取り専用として設定します。 接続文字列内のパスワードは*****として表示されます。

protectConnectionStringsが有効になっている場合、Compass はEdit connection stringオプションを無効にし、 Edit connection stringトグルを非表示にします。

詳細については、「 接続stringで認証情報を非表示にする 」を参照してください。

--protectConnectionStringsForNewConnections

新しい接続の接続文字列をデフォルトで読み取り専用として設定します。 新しい接続文字列内のパスワードは*****として表示されます。

protectConnectionStringsForNewConnectionsが有効になっている場合、Compass はEdit connection stringオプションを無効にしますが、ユーザーがEdit connection stringトグルを使用してオプションを手動で有効にすることを妨げるものではありません。

--readOnly

Compass を通じて MongoDB 配置への書込み操作がユーザーに実行されるのを防ぎます。

詳細については、「 MongoDB への書込み操作の制限 」を参照してください。

--showInsights

スキーマとクエリのパフォーマンスに関するインサイトを有効にします。

詳細については、「パフォーマンスインサイト 」を参照してください。

--showKerberosPasswordField

Compass 接続フォームで Kerberos のパスワード フィールドを表示または非表示にします。

詳細については、「 Kerberos パスワード フィールドの表示 」を参照してください。

--showOIDCDeviceAuthFlow

MongoDB サーバー上で OIDC 認証のデバイス認可フローを有効にします。 これにより、安全性の低い認証フローが可能になり、ブラウザベースの認証が利用できない場合のフォールバックとして使用できます。

--theme

MongoDB Compass UI のテーマを指定します。 サポートされているテーマは、 DARKLIGHTOS_THEMEです。

--trackUsageStatistics

使用状況統計の送信を有効にします。 使用状況統計の送信を無効にするには、 --no-trackUsageStatisticsを使用します。

詳細については、「 テレメトリオプションの構成 」を参照してください。

--username

接続 で提供された と 配置への認証に使用するユーザー名を指定しますCompassMongoDBstring

オプションで、--password と組み合わせて使用します。

注意

利用可能なすべての Compass 構成オプションを表示するには、MongoDB Compass 実行可能ファイルを含むフォルダーで次のコマンドを実行します。

<path-to-Compass-executable> --help