文档菜单
文档首页
/
MongoDB Shell
/
配置
/
配置设置

使用配置文件配置设置

本页内容

  • 配置文件格式
  • 配置文件位置
  • 可配置设置
  • 与config API

您可以指定mongosh的设置在全局配置文件中。当你在配置文件中指定设置时，这些设置将在启动时应用。创建配置文件后，下次启动mongosh时，文件中的设置将生效。

配置文件格式

mongosh配置文件使用YAML格式。所有选项都在mongosh命名空间下。

示例配置文件

以下配置文件设置

  • displayBatchSize为50

  • inspectDepth为20

  • redactHistory为remove-redact

mongosh:
  displayBatchSize: 50
  inspectDepth: 20
  redactHistory: "remove-redact"

配置文件位置

mongosh查找配置文件的文件位置取决于您的操作系统

操作系统
文件位置
Windows
mongosh.cfg，位于mongosh.exe二进制文件相同的目录中。
macOS

mongosh 将按照以下顺序在指定目录中查找配置文件

  1. /usr/local/etc/mongosh.conf

  2. /opt/homebrew/etc/mongosh.conf

  3. /etc/mongosh.conf

一旦 mongosh 在这些目录中的一个读取了配置文件，列表中剩余的目录将不再检查，并且这些目录中的配置文件将被忽略。

Linux
/etc/mongosh.conf

可配置设置

您可以在配置文件中指定以下 mongosh 设置

键
类型
默认值
描述
displayBatchSize
整数
20
每轮游标迭代显示的项目数
enableTelemetry
布尔值
true
启用向 MongoDB 发送匿名跟踪和诊断数据。
editor
字符串
null
指定在mongosh 控制台中使用的编辑器。如果设置，将覆盖 EDITOR 环境变量。
forceDisableTelemetry
布尔值
false
仅在全局配置文件中可用。当为 true 时，用户无法手动启用遥测。
historyLength
整数
1000
存储在 mongosh REPL 历史文件中的项目数。
inspectCompact
整数或布尔值
3

在单行上 mongosh 输出的内部元素级别。短数组元素也将在单行上分组。

如果设置为 false，则 mongosh 将每个字段单独输出一行。

inspectDepth
整数或 Infinity
6
对象打印的深度。将 inspectDepth 设置为 Infinity（javascript 对象）将打印所有嵌套对象的完整深度。
redactHistory
字符串
remove

控制记录在 shell 历史中的信息。必须是以下之一

  • keep：保留所有历史记录。

  • remove：删除包含敏感信息的行。

  • remove-redact：红字敏感信息。

showStackTraces
布尔值
false
控制错误消息中堆栈跟踪的显示。
snippetAutoload
布尔值
true
如果为 true，则在启动时自动加载已安装的 snippets。
snippetIndexSourceURLs
字符串
MongoDB 存储库
由分号分隔的 URL 列表，这些 URL 链接到 代码片段 注册表。
snippetRegistryURL
字符串
mongosh npm 客户端所使用的 npm 注册表，用于安装 代码片段。

使用 config API 的行为

使用 config API 指定的设置：

  • 覆盖配置文件中指定的设置。

  • 跨重启持久化。

示例

考虑以下配置文件，它将 inspectDepth 设置为 20

mongosh:
  inspectDepth: 20

在您的 mongosh 会话中，您运行以下命令将 inspectDepth 设置为 10

config.set( "inspectDepth", 10 )

inspectDepth 的值变为 10，并且即使 mongosh 重新启动，它也将保持 10。

返回

使用API

下一步

自定义提示符