对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单

配置文件设置

您可以使用配置文件,在启动时自定义 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的父文件夹中。

您可以用 EJSON 或 YAML 格式配置 Compass 配置文件设置。

{
"setting": value,
"setting": value,
...
}
setting option: value
setting option: value
...
设置
定义

autoUpdates

允许 Compass 定期检查新的更新。

enableAtlasSignIn

Allow users to sign in to their Atlas account and access their clusters and data. Defaults to true.

您只能在配置文件中设立此设置。您无法通过Compass界面或命令行设立。

支持 Compass 使用生成式人工智能进行自然语言查询。

enableGenAISampleDocumentPassing

允许MongoDB Compass发送带有查询和聚合生成请求的示例字段值。 这些值可以改进AI的结果。

如果为 true,此设置会隐式将 enableGenAIFeatures 设置为 true

在 Compass 中启用 Chrome DevTools。

要了解详情,请参阅切换 Chrome DevTools

enableMaps

允许 Compass 向第三方地图服务发出请求。

启用或禁用 Compass 上的嵌入式 MongoDB Shell。

要了解更多信息,请参阅禁用嵌入式 MongoDB Shell

当您通过 Compass 连接 MongoDB 部署时,分配连接选项值。这些连接选项不能被 Compass 界面的连接或命令行连接字符串覆盖。

忽略其他命令行标志

允许或禁止其他命令行选项标志。

installURLHandlers

将 Compass 注册为 mongodb:// 和 mongodb+srv:// URL 的处理程序。

If Install Compass as URL Protocol Handler is enabled, you can open Compass by navigating to a mongodb:// or mongodb+srv:// URL in your Internet browser.

适用于 macOS 和 Windows。

maxTimeMS

为所有 Compass 数据库操作指定时间上限。

禁止 MongoDB Compass 执行除数据库相关操作以外的传出网络操作。

将所有连接字符串设置为只读。连接字符串中的密码显示为 *****

如果启用了 protectConnectionStrings,Compass 将禁用 Edit connection string(编辑连接字符串)选项并隐藏 Edit connection string(编辑连接字符串)开关。

protectConnectionStringsForNewConnections

默认情况下,将新连接的连接字符串设置为只读。新连接字符串中的密码显示为 *****

如果启用了 protectConnctionStringsForNewConnections,Compass 将禁用 Edit connection string(编辑连接字符串)选项,但不会禁止用户使用 Edit connection string(编辑连接字符串)开关手动启用该选项。

代理

使您能够指定或实施使用代理来连接到部署。有关使用代理连接到部署的更多信息,请参阅“代理/SSH 隧道连接”标签页

您必须传递URL或以下格式:

{
"proxy": "string",
"noProxyHosts": "string"
}

如果将 proxy设立为空字符串,Compass不使用代理。

防止用户通过 Compass 对 MongoDB 部署执行写入操作。

如需了解更多信息,请参阅“限制对 MongoDB 的写操作”。

在 Compass 连接表单上显示或隐藏 Kerberos 密码字段。

要了解详情,请参阅显示 Kerberos 密码字段

主题

指定 MongoDB Compass 用户界面主题。支持的主题包括 DARK(深色)、LIGHT(浅色)和OS_THEME(操作系统主题)。

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