/ /

MongoDB CLI 構成ファイル

MongoDB CLI 構成ファイルにはプロファイルが保存されています。構成ファイルに保存されている設定は、テキストエディタでファイルを編集するか、 mongocli config setコマンドを使用して更新できます。

重要

APIキーはパスワードのようなものです。構成ファイルにはAPIキーがプレーンテキストで保存されるため、構成ファイルが適切に保護されていることを確認してください。

構成ファイルのロケーション

mongocli configコマンドを初めて実行すると、MongoDB CLI はconfig.tomlという構成ファイルを作成します。 MongoDB CLI は、コマンドを実行したユーザーに、ファイルへの読み取りアクセス権および書込みアクセス権を付与します。 MongoDB CLI は、オペレーティングシステムに応じて次の場所に構成ファイルを保存します。

%AppData/mongocli

/Users/{username}/Library/Application Support/mongocli

$XDG_CONFIG_HOME/mongocli

$XDG_CONFIG_HOMEが設定されていない場合、MongoDB CLI は次を使用します。

$HOME/.config/mongocli

プロファイル

MongoDB CLI 構成ファイルには、関連する設定とAPIキーがプロファイルと呼ばれるグループに保存されます。複数のプロファイルを作成または定義できるため、MongoDB CLI を使用して同じターミナルからさまざまな MongoDB サービスやプロジェクトにアクセスできます。

注意

環境変数に保存されている設定は、プロファイルに保存されている設定よりも優先されます。

特定のプロファイルで MongoDB CLI を実行するには、コマンドに--profile <profileName>オプションを追加します。

デフォルトのプロファイル

--profileオプションを指定せずにコマンドを実行すると、MongoDB CLI はデフォルトのプロファイル内の設定を使用します。 MongoDB CLI では、設定したプロファイルの数によってデフォルトのプロファイルが決まります。

プロファイルが 1 つしかない場合、MongoDB CLI はデフォルトでそのプロファイルを使用します。
複数のプロファイルがある場合、MongoDB CLI はデフォルトとしてdefaultという名前のプロファイルを使用します。 defaultという名前のプロファイルがない場合に、特定の設定を必要とするコマンドを実行すると、MongoDB CLI は欠落している設定に対するエラーを返します。

例

次の構成ファイルの例には、 MongoDB Shell へのパスと 2mongosh つのプロファイルdefault とmyOpsManager へのパスが含まれています。

defaultプロファイルは Atlas 配置に接続し、次の設定を含む。

組織 ID
APIキー
プロジェクトID

myOpsManager プロファイルはMongoDB Ops Manager配置に接続し、次の設定を含む。

MongoDB Ops Manager ベースURL。
組織 ID。
APIキー。
プロジェクトID。
任意クライアントと MongoDB Ops Manager TLS 証明書に署名するために使用される PEM でエンコードされた CA（Certificate Authority、認証局）証明書へのローカルシステム上のフルパス
CA TLS 証明書が検証されているかどうかを示す任意のフラグ。

$XDG_CONFIG_HOME/mongocli/config.toml
mongosh_path = "/usr/local/bin/mongosh"
[default]
  organization_id = "qwer5678uiop23jb45lk78mn"
  public_api_key = "ABCDEFG"
  project_id= "5e2f04ecf10fcd33c7d4077e"
  private_api_key = "e750d2bf-1234-4cde-5678-ca4dcbcac9a4"
  service = "cloud"
[myOpsManager]
  ops_manager_ca_certificate = /etc/ssl/certs/ca.pem
  ops_manager_skip_verify = no
  ops_manager_url = "http://localhost:9080/"
  organization_id = "jklsa23123dsdf3jj456hs2"
  public_api_key = "HIJKLMN"
  project_id = "kk12jdn43jd123dkdkf97jg"
  private_api_key = "e750d2bf-9101-4cde-1121-ca4dcbcac9a5"
  service = "ops-manager"

defaultプロファイルで MongoDB CLI を使用するには、コマンドから--profileオプションを省略します。

mongocli <command>

myOpsManagerプロファイルで MongoDB CLI を使用するには、コマンドに--profile myOpsManagerオプションを追加します。

mongocli <command> --profile myOpsManager

戻る

構成する

環境変数