Options选项

General Options常规选项

--build-info

Returns a JSON-formatted document with information about the mongosh build.返回一个JSON格式的文档，其中包含有关mongosh构建的信息。

--eval <javascript>

Evaluates a JavaScript expression. You can use a single --eval argument or multiple --eval arguments together.评估JavaScript表达式。可以使用单个--eval参数，也可以同时使用多个--eval参数。

After mongosh evaluates the --eval argument, it prints the results to your command line. mongosh对--eval参数求值后，会将结果打印到命令行中。If you use multiple --eval statements, mongosh only prints the results of the last --eval.如果使用多个--eval语句，mongosh只打印最后一个--eval的结果。

Example: Format Output

To get output suitable for automated parsing, use EJSON.stringify().要获得适合自动解析的输出，请使用EJSON.stringify()。

mongosh --quiet  --host rs0/centos1104 --port 27500 \
        --eval "EJSON.stringify(rs.status().members.map( \
          m => ({'id':m._id, 'name':m.name, 'stateStr':m.stateStr})));" \
| jq

After parsing with jq, the output resembles this:使用jq进行解析后，输出类似于以下内容：

[
  {
     "id": 0,
     "name": "centos1104:27500",
     "stateStr": "PRIMARY"
  },
  {
     "id": 1,
     "name": "centos1104:27502",
     "stateStr": "SECONDARY"
  },
  {
     "id": 2,
     "name": "centos1104:27503",
     "stateStr": "SECONDARY"
  }
]

Note

EJSON has built in formatting options which may eliminate the need for a parser like jq. For example, the following code produces output that is formatted the same as above.EJSON内置了格式化选项，可以消除对像jq这样的解析器的需求。例如，下面的代码生成的输出格式与上面相同。

mongosh --quiet  --host rs0/centos1104 --port 27500 \
        --eval "EJSON.stringify( rs.status().members.map( \
          ({ _id, name, stateStr }) => ({ _id, name, stateStr })), null, 2);"

Example: Multiple ``--eval`` Arguments

To get a list of collections in the moviesDatabase, use multiple --eval statements:要在moviesDatabase中获取集合列表，请使用多个--eval语句：

mongosh --quiet \
        --eval 'use moviesDatabase' \
        --eval 'show collections' \
        mongodb://localhost/

--help, -h

Returns information on the options and use of the MongoDB Shell.返回有关MongoDB Shell的选项和使用的信息。

--nodb

Prevents the shell from connecting to any database instances.阻止外壳程序连接到任何数据库实例。

--norc

Prevents the shell from sourcing and evaluating ~/.mongoshrc.js on startup.阻止shell在启动时查找和评估~/.mongoshrc.js。

--quiet

Skips all messages during startup (such as welcome messages and startup warnings) and goes directly to the prompt.在启动过程中跳过所有消息（如欢迎消息和启动警告），然后直接进入提示。

--shell

Enables the shell interface. 启用外壳程序界面。If you invoke the mongosh command and specify a JavaScript file as an argument, or use --eval to specify JavaScript on the command line, the --shell option provides the user with a shell prompt after the file finishes executing.如果调用mongosh命令并指定一个JavaScript文件作为参数，或者在命令行中使用--eval指定JavaScript，那么在文件执行完成后，--shell选项将为用户提供shell提示。

--verbose

Increases the verbosity of the shell output during the connection process and when running commands.在连接过程中和运行命令时增加shell输出的详细程度。

--version

Returns the MongoDB Shell release number.返回MongoDB Shell版本号。

Stable API Options稳定的API选项

--apiVersion <version number>

Specifies the apiVersion. 指定apiVersion。"1" is currently the only supported value."1"是当前唯一支持的值。

--apiStrict

Specifies that the server will respond with APIStrictError if your application uses a command or behavior outside of the Stable API.指定如果应用程序使用Stable API之外的命令或行为，则服务器将使用APIStrictError进行响应。

If you specify --apiStrict, you must also specify --apiVersion.如果指定--apiStrict，则还必须指定--apiVersion。

--apiDeprecationErrors

Specifies that the server will respond with APIDeprecationError if your application uses a command or behavior that is deprecated in the specified apiVersion.指定如果应用程序使用的命令或行为在指定的apiVersion中已弃用，则服务器将使用APIDeprecationError进行响应。

If you specify --apiDeprecationErrors, you must also specify --apiVersion.如果指定--apiDeprecationErrors，则还必须指定--apiVersion。

Connection Options连接选项

--host <hostname>

Specifies the name of the host machine where the mongod or mongos is running. 指定运行mongod或mongos的主机的名称。If this is not specified, the MongoDB Shell attempts to connect to a MongoDB process running on the localhost.如果未指定，MongoDB Shell将尝试连接到本地主机上运行的MongoDB进程。

To connect to a replica set,为了连接到副本集，

Specify the replica set name and a seed list of set members. 指定副本集名称和集成员的种子列表。Use the following form:使用以下表格：

<replSetName>/<hostname1><:port>,<hostname2><:port>,<...>

For TLS/SSL connections (--tls),对于TLS/SSL连接（--tls），

The MongoDB Shell shell verifies that the hostname (specified in the --host option or the connection string) matches the SAN (or, if SAN is not present, the CN) in the certificate presented by the mongod or mongos. MongoDB Shell Shell验证主机名（在--host选项或连接字符串中指定）是否与mongod或mongos提供的证书中的SAN（或者，如果不存在SAN，则为CN）匹配。If SAN is present, the MongoDB Shell does not match against the CN. 如果存在SAN，则MongoDB Shell与CN不匹配。If the hostname does not match the SAN (or CN), the MongoDB Shell shell fails to connect.如果主机名与SAN（或CN）不匹配，则MongoDB Shell外壳无法连接。

For DNS seedlist connections,对于DNS种子列表连接，

Specify the connection protocol as mongodb+srv, followed by the DNS SRV hostname record and any options. 将连接协议指定为mongodb+srv，然后指定DNS srv主机名记录和任何选项。The authSource and replicaSet options, if included in the connection string, overrides any corresponding DNS-configured options set in the TXT record. authSource和replicaSet选项（如果包含在连接字符串中）将覆盖TXT记录中设置的任何相应的DNS配置选项。Use of the mongodb+srv: connection string implicitly enables TLS / SSL (normally set with tls=true) for the client connection. 使用mongodb+srv:连接字符串会隐式启用客户端连接的TLS/SSL（通常设置为TLS=true）。The TLS option can be turned off by setting tls=false in the query string.可以通过在查询字符串中设置TLS=false来关闭TLS选项。

mongodb+srv://server.example.com/?connectionTimeout=3000ms

--port <port>

Specifies the port where the mongod or mongos instance is listening. 指定mongod或mongos实例正在侦听的端口。If --port is not specified, the MongoDB Shell attempts to connect to port 27017.如果没有指定--port，MongoDB Shell将尝试连接到27017端口。

Authentication Options身份验证选项

--authenticationDatabase <dbname>

Specifies the authentication database where the specified --username has been created. 指定创建指定的--username的身份验证数据库。See Authentication Database.请参阅身份验证数据库。

If you do not specify a value for --authenticationDatabase, the MongoDB Shell uses the database specified in the connection string.如果没有为--authenticationDatabase指定值，MongoDB Shell将使用连接字符串中指定的数据库。

--authenticationMechanism <name>

Specifies the authentication mechanism the MongoDB Shell uses to authenticate to the mongod or mongos. 指定MongoDB Shell用于向mongod或mongos进行身份验证的身份验证机制。If you don't specify an authenticationMechanism but provide user credentials, the MongoDB Shell and drivers attempt to use SCRAM-SHA-256. If this fails, they fall back to SCRAM-SHA-1.如果您没有指定authenticationMechanism，但提供了用户凭据，MongoDB Shell和驱动程序会尝试使用SCRAM-SHA-256。如果失败，则返回SCRAM-SHA-1。

Value值	Description描述
SCRAM-SHA-1	RFC 5802 standard Salted Challenge Response Authentication Mechanism using the SHA-1 hash function.使用SHA-1散列函数的标准Salted质询-响应认证机制。
SCRAM-SHA-256	RFC 7677 standard Salted Challenge Response Authentication Mechanism using the SHA-256 hash function.使用SHA-256散列函数的标准Salted质询-响应认证机制。 Requires featureCompatibilityVersion set to 4.0.需要将featureCompatibilityVersion设置为4.0。
MONGODB-X509	MongoDB TLS / SSL certificate authentication.MongoDB TLS/SSL证书身份验证。
GSSAPI (Kerberos)	External authentication using Kerberos. 使用Kerberos的外部身份验证。This mechanism is available only in MongoDB Enterprise.此机制仅在MongoDB Enterprise中可用。
PLAIN (LDAP SASL)	External authentication using LDAP. 使用LDAP的外部身份验证。You can also use PLAIN for authenticating in-database users. 您还可以使用PLAIN对数据库中的用户进行身份验证。PLAIN transmits passwords in plain text. PLAIN以纯文本形式传输密码。This mechanism is available only in MongoDB Enterprise.此机制仅在MongoDB Enterprise中可用。

--gssapiServiceName

Specify the name of the service using GSSAPI/Kerberos. 使用GSSAPI/Kerberos指定服务的名称。Only required if the service does not use the default name of mongodb.仅当服务未使用mongodb的默认名称时才需要。

This option is available only in MongoDB Enterprise.此选项仅在MongoDB Enterprise中可用。

--sspiHostnameCanonicalization <string>

Specifies whether or not to use Hostname Canonicalization.指定是否使用主机名规范化。

--sspiHostnameCanonicalization has the same effect as setting the CANONICALIZE_HOST_NAME:true|false key-pair in the authMechanismProperties portion of the connection string.具有与在连接字符串的authMechanismProperties部分中设置CANONICALIZE_HOST_NAME:true|false密钥对相同的效果。

If --sspiHostnameCanonicalization is set to:如果--sspiHostnameCanonicalization设置为：

• forwardAndReverse, performs a forward DNS lookup and then a reverse lookup. ，执行正向DNS查找，然后执行反向查找。New in mongosh 1.3.0.
• forward, the effect is the same as setting authMechanismProperties=CANONICALIZE_HOST_NAME:true.，效果与设置authMechanismProperties=CANONICALIZE_HOST_NAME:true相同。
• none, the effect is the same as setting authMechanismProperties=CANONICALIZE_HOST_NAME:false.，效果与设置authMechanismProperties=CANONICALIZE_HOST_NAME:false相同。

--password <password>, -p <password>

Specifies a password with which to authenticate to a MongoDB database that uses authentication. 指定用于向使用身份验证的MongoDB数据库进行身份验证的密码。Use in conjunction with the --username and --authenticationDatabase options.与--username和--authenticationDatabase选项一起使用。

To force the MongoDB Shell to prompt for a password, enter the --password option as the last option and leave out the argument.要强制MongoDB Shell提示输入密码，请输入--password选项作为最后一个选项，并省略参数。

--username <username>, -u <username>

Specifies a username with which to authenticate to a MongoDB database that uses authentication. 指定用于向使用身份验证的MongoDB数据库进行身份验证的用户名。Use in conjunction with the --password and --authenticationDatabase options.与--password和--authenticationDatabase选项一起使用。

Session Options会话选项

--retryWrites

Enables Retryable Writes. 启用可重试写入。Retryable writes are enabled by default in mongosh. mongosh中默认启用可重试写入。Retryable writes are disabled by default in the legacy mongo shell. 在传统mongo shell中，默认情况下禁用可重试写入。To disable retryable writes, use --retryWrites=false.若要禁用可重试写入，请使用--retryWrites=false。

For more information on sessions, see Client Sessions and Causal Consistency Guarantees.有关会话的更多信息，请参阅客户端会话和因果一致性保证。

Client-Side Field Level Encryption Options客户端字段级加密选项

--awsAccessKeyId <string>

An AWS Access Key associated with an IAM user who has List and Read permissions for the AWS Key Management Service (KMS). 与IAM用户关联的AWS访问密钥，IAM用户具有AWS密钥管理服务（KMS）的List和Read权限。mongosh uses the specified --awsAccessKeyId to access the KMS.mongosh使用指定的--awsAccessKeyId访问KMS。

--awsAccessKeyId is required to enable Client-Side Field Level Encryption for the mongosh shell session. --awsAccessKeyId是为mongosh shell会话启用客户端字段级加密所必需的。--awsAccessKeyId requires both of the following command line options:需要以下两个命令行选项：

• --awsSecretAccessKey
• --keyVaultNamespace

If --awsAccessKeyId is omitted, use the Mongo() constructor within the shell session to enable client-side field level encryption.如果省略了--awsAccessKeyId，请在shell会话中使用Mongo()构造函数来启用客户端字段级加密。

To mitigate the risk of leaking access keys into logs, consider specifying an environmental variable to --awsAccessKeyId.要降低将访问密钥泄漏到日志中的风险，请考虑将环境变量指定为--awsAccessKeyId。

--awsSecretAccessKey <string>

An AWS Secret Key associated to the specified --awsAccessKeyId.与指定的--awsAccessKeyId.关联的AWS密钥。

--awsSecretAccessKey is required to enable Client-Side Field Level Encryption for the mongosh session. --awsSecretAccessKey是为mongosh会话启用客户端字段级加密所必需的。--awsSecretAccessKey requires both of the following command line options:--awsSecretAccessKey需要以下两个命令行选项：

• --awsAccessKeyId
• --keyVaultNamespace

If --awsSecretAccessKey and its supporting options are omitted, use Mongo() within the shell session to enable client-side field level encryption.如果省略了--awsSecretAccessKey及其支持选项，请在shell会话中使用Mongo()来启用客户端字段级加密。

To mitigate the risk of leaking access keys into logs, consider specifying an environmental variable to --awsSecretAccessKey.要降低将访问密钥泄漏到日志中的风险，请考虑将环境变量指定为--awsSecretAccessKey。

--awsSessionToken <string>

An AWS Session Token associated to the specified --awsAccessKeyId.与指定的--awsAccessKeyId关联的AWS会话令牌。

--awsSessionToken is required to enable Client-Side Field Level Encryption for the mongosh shell session. --awsSessionToken是为mongosh shell会话启用客户端字段级加密所必需的。--awsSessionToken requires all of the following command line options:需要以下所有命令行选项：

• --awsAccessKeyId
• --awsSecretAccessKey
• --keyVaultNamespace

If --awsSessionToken and its supporting options are omitted, use Mongo() within the shell session to enable client-side field level encryption.如果省略了--awsSessionToken及其支持选项，请在shell会话中使用Mongo()来启用客户端字段级加密。

To mitigate the risk of leaking access keys into logs, consider specifying an environmental variable to --awsSessionToken.要降低将访问密钥泄漏到日志中的风险，请考虑为--awsSessionToken指定一个环境变量。

--keyVaultNamespace <string>

The full namespace (<database>.<collection>) of the collection used as a key vault for Client-Side Field Level Encryption. 用作客户端字段级加密的密钥保管库的集合的完整命名空间（<database>.<collection>）。--keyVaultNamespace is required for enabling client-side field level encryption. --keyVaultNamespace是启用客户端字段级加密所必需的。for the mongosh shell session. 用于mongosh shell会话。mongosh creates the specified namespace if it does not exist.如果指定的命名空间不存在，则创建该命名空间。

--keyVaultNamespace requires both of the following command line options:--keyVaultNamespace需要以下两个命令行选项：

• --awsAccessKeyId
• --awsSecretAccessKey

If --keyVaultNamespace and its supporting options are omitted, use the Mongo() constructor within the shell session to enable client-side field level encryption.如果省略了--keyVaultNamespace及其支持选项，请在shell会话中使用Mongo()构造函数来启用客户端字段级加密。