Docs Home / mongosh / Configure

Configure Settings配置设置

To specify certain shell behaviors, you can configure mongosh settings.要指定某些shell行为,可以配置mongosh设置。

Configurable Settings可配置设置

You can configure the following settings for mongosh:您可以为mongosh配置以下设置:

KeyType类型Default默认Description描述
browserstring or booleanSystem default browser系统默认浏览器

Specifies the browser mongosh redirects you to when MONGODB-OIDC is enabled.指定启用MONGODB-OIDC时浏览器mongosh将您重定向到的位置。

This option is run with the system shell.此选项与系统shell一起运行。

Set browser to false to disable opening browsers entirely.browser设置为false以完全禁用打开浏览器。

disableLoggingbooleanfalseSpecifies whether MongoDB Shell writes log entries.指定MongoDB Shell是否写入日志条目。
disableSchemaSamplingbooleanfalse

By default, MongoDB Shell samples your database schema to enable autocomplete suggestions.默认情况下,MongoDB Shell会对数据库模式进行采样,以启用自动完成建议。

If you set this setting to true, MongoDB Shell does not sample your database schema and autocomplete behaves as if the collection is empty.如果将此设置设置为true,MongoDB Shell不会对数据库模式进行采样,自动补全的行为就像集合为空一样。

displayBatchSizeinteger20The number of items displayed per cursor iteration每次游标迭代显示的项目数
enableTelemetrybooleantrueEnables sending anonymized tracking and diagnostic data to MongoDB.允许向MongoDB发送匿名跟踪和诊断数据。
editorstringnullDesignates an editor to use within the mongosh console. Overrides the EDITOR environment variable if set.指定要在mongosh控制台中使用的编辑器。如果已设置,则覆盖EDITOR环境变量。
forceDisableTelemetrybooleanfalseOnly available in the global configuration file. When true, users cannot enable telemetry manually.仅在全局配置文件中可用。当为真时,用户无法手动启用遥测。
historyLengthinteger1000The number of items to store in mongosh REPL's history file.存储在mongosh REPL历史文件中的项目数。
inspectCompactinteger or boolean3

The level of inner elements that mongosh outputs on a single line. Short array elements are also grouped together on a single line.mongosh在单行上输出的内部元素的级别。短数组元素也被组合在一条线上。

If set to false, mongosh outputs each field on its own line.如果设置为falsemongosh将在其自己的行上输出每个字段。

inspectDepthinteger or Infinity6The depth to which objects are printed. Setting inspectDepth to Infinity (the javascript object) prints all nested objects to their full depth.打印对象的深度。将inspectDepth设置为Infinity(javascript对象)会将所有嵌套对象打印到其完整深度。
logCompressionEnabledbooleanfalseSpecifies whether MongoDB Shell compresses log files. When this value is true, MongoDB Shell uses gzip to compress logs. See Enable Log Compression.指定MongoDB Shell是否压缩日志文件。当此值为真时,MongoDB Shell使用gzip压缩日志。请参阅启用日志压缩
logLocationstringDepends on your operating system. See View Shell Logs.这取决于你的操作系统。请参阅查看Shell日志Directory where MongoDB Shell writes log files. Specify an absolute filepath. See Specify Log File Location.MongoDB Shell写入日志文件的目录。指定绝对文件路径。请参见指定日志文件位置
logMaxFileCountinteger or Infinity100Maximum number of log files that the MongoDB Shell retains. After the MongoDB Shell reaches the maximum log file count, it starts deleting the oldest log files until the count is below the threshold. MongoDB Shell保留的最大日志文件数。MongoDB Shell达到最大日志文件计数后,它开始删除最旧的日志文件,直到计数低于阈值。See Modify Maximum Log File Count.请参见修改最大日志文件计数
logRetentionDaysinteger or Infinity30Number of days that MongoDB Shell log files are retained. If this value is set to Infinity, log files are not deleted based on age. MongoDB Shell日志文件保留的天数。如果此值设置为Infinity,则不会根据年龄删除日志文件。To prevent log storage from growing too large, always specify at least one log retention criterion. See Log Retention.为防止日志存储增长得太大,请始终至少指定一个日志保留标准。请参阅日志保留
logRetentionGBfloat or InfinityUnset

Maximum amount of space in gigabytes used for MongoDB Shell logs. If the combined size of MongoDB Shell logs exceeds this value, log files are deleted starting with the oldest logs.MongoDB Shell日志使用的最大空间量(GB)。如果MongoDB Shell日志的组合大小超过此值,则从最旧的日志开始删除日志文件。

If this value is set to Infinity, log files are not deleted based on storage size. To prevent log storage from growing too large, always specify at least one log retention criterion. 如果此值设置为Infinity,则不会根据存储大小删除日志文件。为防止日志存储增长得太大,请始终至少指定一个日志保留标准。See Log Retention.请参阅日志保留

oidcRedirectUristringhttp://localhost:27097/redirectSpecifies a URI where the identity provider redirects you after authentication. The URI must match the configuration of the identity provider. The default is http://localhost:27097/redirect.指定身份验证后身份提供程序重定向URI。URI必须与身份提供程序的配置匹配。默认值为http://localhost:27097/redirect
oidcTrustedEndpointsarray of strings[] (empty array)Specifies an array of trusted endpoint hostnames, including possible wildcards, that are not Atlas or localhost. Access tokens are sent to these endpoints. Only configure endpoints that you trust.指定一组受信任的端点主机名,包括可能的通配符,这些通配符不是Atlas或localhost。访问令牌被发送到这些端点。仅配置您信任的端点。
redactHistorystringremove

Controls what information is recorded in the mongosh command history. You can access the mongosh command history via the up and down keys or Ctrl+R while inside the shell.控制mongosh命令历史记录中记录的信息。在shell中,您可以通过上下键或Ctrl+R访问mongosh命令历史记录。

Must be one of the following values:必须是以下值之一:

  • keep: Retain all history.:保留所有历史。
  • remove: Remove lines that contain sensitive commands from the history. For example, remove removes calls to db.auth() or connect().:从历史记录中删除包含敏感命令的行。例如,remove会删除对db.auth()connect()的调用。
  • remove-redact: Remove lines that contain sensitive commands and redact specific strings in other history lines, such as file paths, email addresses, and URLs.:删除包含敏感命令的行,并在其他历史行中编辑特定字符串,如文件路径、电子邮件地址和URL。
showStackTracesbooleanfalseControls display of a stack trace along with error messages.控制堆栈跟踪和错误消息的显示。
snippetAutoloadbooleantrueIf true, automatically load installed snippets at startup.如果为true,则在启动时自动加载已安装的代码段
snippetIndexSourceURLsstringMongoDB RepositoryA semicolon-separated list of URLs that link to a snippet registry.链接到代码段注册表的以分号分隔的URL列表。
snippetRegistryURLstringnpm RegistryThe npm registry used by the mongosh npm client that installs snippet.安装代码段mongosh npm客户端使用的npm注册表。

How to Configure Settings如何配置设置

To configure mongosh settings, you can either use:要配置mongosh设置,您可以使用: