Configure Settings Using the API使用API配置设置

Supported property parameters支持的属性参数

Remove or Redact Sensitive Information From History从历史记录中删除或更正敏感信息

mongosh makes "best-effort" attempts to match patterns that normally correspond to certain kinds of sensitive information.尽“最大努力”尝试匹配通常与某些类型的敏感信息相对应的模式。

There are patterns that match:有一些模式是匹配的：

• Certificates and keys证书和键
• Email addresses电子邮件地址
• Generic user directories通用用户目录
• HTTP(s) URLs
• IP addresses网际协议地址
• MongoDB connection stringsMongoDB连接字符串

Certain operations, such as connect(), are considered inherently sensitive. If redactHistory is set to remove or remove-redact, lines with these operations will be removed from the command line history.某些操作，如connect()，被认为具有固有的敏感性。如果redactHistory设置为remove或remove-redact，则具有这些操作的行将从命令行历史记录中删除。

Other operations, like find(), sometimes have sensitive information like email addresses. 其他操作，如find()，有时会包含电子邮件地址等敏感信息。The shell history will retain these lines as entered unless redactHistory is set to remove-redact.除非redactHistory设置为删除redact，否则shell历史记录将保留这些输入的行。

Behavior with Configuration File配置文件的行为

Settings specified with the config API:使用configAPI指定的设置：

• Override settings specified in the configuration file.覆盖配置文件中指定的设置。
• Persist across restarts.在重启过程中保持不变。

mongosh:
  inspectDepth: 20

config.set( "inspectDepth", 10 )

Update Number of Items Returned by a Cursor更新游标返回的项目数

Consider viewing a collection with a number of large documents. You can update the batchSize to limit the number of items returned by a cursor.考虑查看包含许多大型文档的集合。您可以更新batchSize以限制游标返回的项目数。

config.set("displayBatchSize", 3)

Future db.collection.find() operations will only return 3 documents per cursor iteration.未来的db.collection.find()操作每次游标迭代只会返回3个文档。

Turn On Stack Traces打开堆栈跟踪

Enable stack traces to see more detailed error reporting.启用堆栈跟踪以查看更详细的错误报告。

config.set("showStackTraces", true)

The output differs like this:输出如下所示：

// showStackTraces set to 'false'
Enterprise> db.orders.find( {}, { $thisWontWork: 1 } )
MongoError: FieldPath field names may not start with '$'.

// showStackTraces set to 'true'
Enterprise> db.orders.find( {}, { $thisWontWork: 1 } )
Uncaught:
MongoError: FieldPath field names may not start with '$'.
    at MessageStream.messageHandler (/usr/bin/mongosh:58878:20)
    at MessageStream.emit (events.js:315:20)
    at MessageStream.EventEmitter.emit (domain.js:548:15)
    at processIncomingData (/usr/bin/mongosh:57954:12)
    at MessageStream._write (/usr/bin/mongosh:57850:5)
    at writeOrBuffer (_stream_writable.js:352:12)
    at MessageStream.Writable.write (_stream_writable.js:303:10)
    at Socket.ondata (_stream_readable.js:719:22)
    at Socket.emit (events.js:315:20)
    at Socket.EventEmitter.emit (domain.js:548:15)

Call config API from outside mongosh从mongosh外部调用config API

You can call the config API from the command line using --eval with mongosh. 您可以使用带有mongosh的--eval从命令行调用配置API。In this case the --nodb option means mongosh will update without connecting to a MongoDB database.在这种情况下，--nodb选项意味着mongosh将在不连接到MongoDB数据库的情况下进行更新。

mongosh --nodb --eval 'config.set("enableTelemetry", true)'

mongosh returns additional information along with the result of the API call.返回附加信息以及API调用的结果。

Current Mongosh Log ID:      609583b730e14918fa0d363f
Using MongoDB:               undefined
Using Mongosh Beta:  0.12.1

For mongosh info see: https://www.mongodb.com/docs/mongodb-shell/

Setting "enableTelemetry" has been changed

Redact Sensitive Information更正敏感信息

Compare the recalled history when redactHistory is set to remove-redact or remove.当redactHistory设置为remove-redact或remove时，比较召回的历史记录。

Set redactHistory to remove-redact mode and enter a query containing an email address.将redactHistory设置为remove-redact模式，并输入包含电子邮件地址的查询。

config.set( "redactHistory", "remove-redact" )
db.contacts.find( {"email": "customer@clients.com" } )

When you press the up arrow to replay the last command the email address is redacted.当您按向上箭头重放最后一个命令时，电子邮件地址将被编辑。

db.contacts.find( {"email": "<email>" } )  // Redacted

Set redactHistory to remove mode and enter a query containing an email address.将redactHistory设置为remove模式，并输入包含电子邮件地址的查询。

config.set( "redactHistory", "remove" )
db.contacts.find( {"email": "customer@clients.com" } )

When you press the up arrow to replay the last command the email address is present.当您按向上箭头重放最后一个命令时，电子邮件地址就会出现。

db.contacts.find( {"email": "customer@clients.com" } )

The shell history reflects the changes. (Note that this stores the most recent input first.)shell历史反映了这些变化。（请注意，这将首先存储最近的输入。）

db.contacts.find( {"email": "customer@clients.com" } )
config.set( "redactHistory", "remove" )
db.contacts.find( {"email": "<email>" } )
config.set( "redactHistory", "remove-redact" )

Reset a Configuration Setting to the Default Value将配置设置重置为默认值

If you modified a configuration setting and want to reset it to the default value, use config.reset( "<property>" ).如果您修改了配置设置并希望将其重置为默认值，请使用config.reset( "<property>" )。

1. Change the value of the historyLength setting to 2000:将historyLength设置的值更改为2000：

   config.set("historyLength", 2000)

2. Verify the updated value for historyLength:验证historyLength的更新值：

   config.get("historyLength")

3. Reset the historyLength setting to the default value of 1000:将historyLength设置重置为默认值1000：

   config.reset("historyLength")

4. Verify the updated value for historyLength:验证historyLength的更新值：

   config.get("historyLength")