Docs 菜单
Docs 主页
/
MongoDB Compass
/

命令行选项

在此页面上

  • 定义
  • Compass 可执行文件位置
  • 语法
  • 选项
  • 了解详情

您可以使用命令行选项自定义 MongoDB Compass。

您可以启动 MongoDB Compass 并从命令行设置配置选项。使用命令行设立配置选项时,这些选项在启动时设置。使用命令行选项配置的设置无法在 Compass 界面上修改。

Compass 可执行文件的名称和位置因操作系统而异。

操作系统
可执行的文件名称
地点
Linux
mongodb-compass
安装程序将其安装在 /usr/bin 目录。
Windows
MongoDBCompass.exe
安装程序将其安装在安装过程所选择的文件夹。
macOS
MongoDB Compass

安装程序将其安装在Applications”文件夹下:

/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

抑制对不允许的连接字符串属性发出警告,并允许自动连接。Compass 会检查在命令行中传递的连接字符串,并验证该连接字符串是否包含可能导致安全风险的参数。

仅当您将已知的可信连接字符串传递给 Compass 时才设置此选项。

--version
显示 MongoDB Compass 版本。

以下选项可以在命令行、配置文件或 Settings(设置)面板中设置。在命令行上设置选项会覆盖 Settings(设置)面板中的值。

设置
定义
--autoUpdates
启用自动更新。使用 --no-autoUpdates 禁用自动更新。
--browserCommandForOIDCAuth
指定一个 shell 命令以在您连接到服务器或登录 Atlas Cloud 帐户时启动浏览器进行 OIDC 身份验证。
--enableFeedbackPanel
启用反馈面板。使用 --no-enableFeedbackPanel 禁用自动更新。
--enableDevTools

在 Compass 中启用 Chrome DevTools。

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

--enableMaps
允许 MongoDB Compass 向第三方映射服务发出请求。使用 --no-enableMaps 禁用映射请求。
--enableShell

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

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

--file <file>
指定一个包含连接列表的文件,这些连接在 MongoDB Compass 启动后自动可用。
--forceConnectionOptions

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

要了解更多信息,请参阅指定读取偏好和标签

--ignoreAdditionalCommandLineFlags
允许额外的命令行标志。
--installURLHandlers

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

如果启用了Install Compass as URL Protocol Handler ,您可以通过在互联网浏览器中导航到 mongodb:// 或 mongodb+srv:// URL 来打开 Compass。

适用于 macOS 和 Windows。

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

将 MongoDB Compass 配置为仅允许传出网络操作连接到数据库。

要了解详情,请参阅阻止外发网络连接

--password

指定用于 Compass 和连接字符串中提供的 MongoDB 部署的身份验证密码。

--username 搭配使用。

--persistOIDCTokens
允许您在使用 MongoDB OIDC 身份验证机制进行 MongoDB server 连接时保持登录状态。会话令牌使用系统钥匙串进行加密和存储。
--protectConnectionStrings

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

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

要了解详情,请参阅在连接字符串中隐藏凭证

--protectConnectionStringsForNewConnections

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

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

--readOnly

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

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

--showInsights

为您的模式和查询提供性能洞察。

如要了解更多信息,请参阅性能见解。

--showKerberosPasswordField

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

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

--showOIDCDeviceAuthFlow
在MongoDB server 上启用 OIDC 身份验证的设备授权流程。这将启用一种安全性较低的身份验证流程,其可以在基于浏览器的身份验证不可用时用作后备方案。
--theme
指定 MongoDB Compass 用户界面主题。支持的主题包括 DARK(深色)、LIGHT(浅色)和OS_THEME(操作系统主题)。
--trackUsageStatistics
启用发送使用情况统计信息。使用 --no-trackUsageStatistics 禁用发送使用情况统计信息。
--username

指定在连接字符串中提供的用于 Compass 和 MongoDB 部署身份验证的用户名

或者,与 --password 结合使用。

注意

要查看所有可用的 Compass 配置选项,请在包含 MongoDB Compass 可执行文件的文件夹中运行以下命令:

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

后退

界面设置