Docs 菜单
Docs 主页
/
MongoDB Atlas
/
MongoDB 命令行界面
/
配置 MongoDB CLI

MongoDB CLI 配置文件

在此页面上

  • 配置文件位置
  • 个人资料
  • 例子

MongoDB CLI配置文件存储您的配置文件。 您可以通过使用文本编辑器编辑配置文件或使用 mongocli config 设立命令来更新存储在配置文件中的设置。

重要

您的 API密钥就像密码一样。 配置文件以明文形式存储API密钥，因此请确保以适当方式保护配置文件。

配置文件位置

首次运行mongocli config 命令时， MongoDB CLI会创建一个名为mongocli.toml 的配置文件。MongoDB CLI授予运行该命令的用户对该文件的写入访问权限。 MongoDB CLI会将配置文件保存到系统存储应用程序配置文件的文件夹中，该文件夹由 $XDG_CONFIG_HOME 环境变量定义。默认，此位置是用户主目录的 /.config 文件夹。如果此文件夹不存在， MongoDB CLI将创建该文件夹并授予用户读取、写入和执行权限。

个人资料

MongoDB CLI 配置文件将相关设置和API密钥存储在名为配置文件的群组中。 您可以创建或定义多个配置文件，以便可以使用 MongoDB CLI 从同一终端访问不同的 MongoDB 服务或项目。

注意

存储在环境变量中的任何设置都优先于存储在配置文件中的设置。

要使用特定配置文件运行 MongoDB CLI，请将 --profile <profileName> 选项附加到命令中。

默认配置文件

如果运行的命令不带 --profile 选项，MongoDB CLI 将使用默认配置文件中的设置。MongoDB CLI 会根据您配置的配置文件数量来确定默认配置文件：

  • 如果只有一个配置文件，MongoDB CLI 会使用该配置文件作为默认配置文件。

  • 如果您有多个配置文件，MongoDB CLI 将使用名为 default 的配置文件作为默认配置文件。如果您没有名为 default 的配置文件，并且运行需要某些设置的命令，则 MongoDB CLI 会因为缺失的设置返回错误。

例子

下面的示例配置文件包含 MongoDB Shell 的路径 mongosh，以及两个配置文件default 和 myOpsManager。

default 配置文件连接到 Atlas 部署，并包含以下设置：

  • 组织 ID

  • API 密钥

  • 项目 ID

myOpsManager 配置文件连接到 Ops Manager 部署并包括以下设置：

  • Ops Manager 基本URL 。

  • 组织 ID。

  • API密钥。

  • 项目 ID。

  • 可选：本地系统上用于签署客户端和 Ops Manager TLS 证书的 PEM 编码证书颁发机构 (CA) 证书的完整路径

  • 可选标志，指示 CA TLS 证书是否已验证。

# ~/.config/mongocli.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

后退

配置 MongoDB CLI

来年

环境变量