옵션

일반 옵션

--build-info

JSON 형식의 문서와 mongosh 빌드 및 드라이버 종속성에 대한 정보를 반환합니다.

예시: 빌드 정보 보기

터미널에서 다음 명령을 실행하여 mongosh 바이너리의 빌드 정보 및 드라이버 종속성을 확인할 수 있습니다:

mongosh --build-info

이 명령은 다음과 같은 JSON 형식의 문서를 반환합니다.

{
  version: '1.10.1',
  distributionKind: 'packaged',
  buildArch: 'x64',
  buildPlatform: 'linux',
  buildTarget: 'unknown',
  buildTime: '2023-06-21T09:49:37.225Z',
  gitVersion: '05ad91b4dd40382a13f27abe1ae8c3f9f52a38f7',
  nodeVersion: 'v16.20.1',
  opensslVersion: '3.1.1',
  sharedOpenssl: true,
  runtimeArch: 'x64',
  runtimePlatform: 'darwin',
  deps: {
     nodeDriverVersion: '5.6.0'
   }
}

--eval <javascript>

JavaScript 표현식을 평가합니다. 단일 --eval 인수를 사용하거나 여러 개의 --eval 인수를 함께 사용할 수 있습니다.

mongosh는 인수를 평가한 후 --eval 결과를 명령줄에 인쇄합니다. --eval 성명서를 여러 개 사용하는 경우 mongosh는 마지막 --eval 결과만 인쇄합니다.

You can use the --json flag with --eval to return mongosh results in Extended JSON format. mongosh supports both --json=canonical and --json=relaxed modes. If you omit the mode, mongosh defaults to the canonical mode. The --json flag is mutually exclusive with --shell.

예시: 형식 출력

자동 구문 분석에 적합한 출력을 얻으려면 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

jq로 구문 분석을 수행하면 다음과 같은 결과가 표시됩니다.

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

참고

EJSON 에는 서식 지정 옵션이 내장되어 jq와 같은 구문 분석기가 필요하지 않을 수 있습니다. 예를 들어, 다음 코드는 위와 동일한 형식의 결과를 생성합니다.

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

예: 다중 --eval 인수

moviesDatabase에서 컬렉션 목록을 확보하려면 여러 --eval 성명서를 사용합니다.

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

예: --json 옵션

여러 --eval 문을 사용하여 확장 JSON 형식으로 컬렉션의 통계를 반환하려면 다음을 수행합니다.

mongosh --quiet --json=relaxed \
        --eval 'use <database-name>' \
        --eval 'db.<collection>.stats()' \
        mongodb://localhost/

--file, -f <javascript>

MongoDB Shell 콘솔에 들어가지 않고 명령줄에서 스크립트를 실행합니다.

자세한 내용과 예제는 명령줄에서 스크립트 실행을 참조합니다.

--help, -h

MongoDB Shell의 옵션 및 사용에 대한 정보를 반환합니다.

--nodb

셸의 데이터베이스 인스턴스 연결을 방지합니다.

--no-quiet

Disables the default --quiet option mode for non-interactive shell sessions. When specified, mongosh displays all messages during startup.

--norc

시작 시 셸의 ~/.mongoshrc.js 소싱 및 평가를 방지합니다.

--norc also prevents the shell from loading any snippets you installed with the snippet install command. Instead, you can load snippets with the snippet load-all command. See Snippet Commands for more information.

--quiet

시작할 때 모든 메시지(예: 환영 메시지 및 시작 경고)를 건너뛰고 프롬프트로 바로 이동합니다.

For non-interactive shell sessions, MongoDB enables --quiet by default. You can disable this behavior using --no-quiet.

--skipStartupWarnings

Prevents mongosh from displaying server startup warnings when creating a session. To suppress all startup messages, use the --quiet option.

--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. The --shell flag is mutually exclusive with --json.

--verbose

연결 프로세스가 진행되는 동안 또는 명령이 실행될 때 셸 결과의 상세도를 높입니다.

--version

MongoDB Shell 릴리스 번호를 반환합니다.

Stable API 옵션

--apiVersion <version number>

Specifies the apiVersion. "1" is currently the only supported value.

--apiStrict

애플리케이션이 Stable API 외부의 명령이나 동작을 사용하는 경우 서버가 APIStrictError 로 응답하도록 지정합니다.

If you specify --apiStrict, you must also specify --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.

If you specify --apiDeprecationErrors, you must also specify --apiVersion.

연결 옵션

--host <hostname>

Specifies the name of the host machine where the mongod or mongos is running. If this is not specified, the MongoDB Shell attempts to connect to a MongoDB process running on the localhost.

다음을 수행하여 복제본 세트에 연결합니다.

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),

The MongoDB 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. If SAN is present, the MongoDB Shell does not match against the CN. If the hostname does not match the SAN (or CN), the MongoDB Shell shell fails to connect.

DNS 시드 목록 연결의 경우,

Specify the connection protocol as mongodb+srv, followed by the DNS SRV hostname record and any options. The authSource and replicaSet options, if included in the connection string, overrides any corresponding DNS-configured options set in the TXT record. Use of the mongodb+srv: connection string implicitly enables TLS (normally set with tls=true) for the client connection. The TLS option can be turned off by setting tls=false in the query string.

예시

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

--port <port>

Specifies the port where the mongod or mongos instance is listening. If --port is not specified, the MongoDB Shell attempts to connect to port 27017.

인증 옵션

--authenticationDatabase <dbname>

Specifies the authentication database where the specified --username has been created. See Authentication Database.

If you do not specify a value for --authenticationDatabase, the MongoDB Shell uses the database specified in the connection string.

--authenticationMechanism <name>

MongoDB Shellmongod또는mongos에 인증하는 데 사용하는 인증 메커니즘 을 지정합니다. authenticationMechanism을(를) 지정하지 않고 사용자 자격 증명 제공하는 경우, MongoDB Shell 및 드라이버는 SCRAM-SHA-256 사용을 시도합니다. 이 작업이 실패하면 SCRAM-SHA-1로 돌아갑니다.

값	설명
SCRAM-SHA-1	RFC 5802 standard Salted Challenge Response Authentication Mechanism using the SHA-1 hash function.
SCRAM-SHA-256	RFC 7677 standard Salted Challenge Response Authentication Mechanism using the SHA-256 hash function. featureCompatibilityVersion이 4.0으로 설정되어야 합니다.
MONGODB-X509	MongoDB TLS certificate authentication.
GSSAPI (Kerberos)	Kerberos를 사용한 외부 인증. 이 메커니즘은 MongoDB Enterprise에서만 사용할 수 있습니다.
PLAIN (LDAP SASL)	LDAP 사용한 외부 인증 . PLAIN 을(를) 사용하여 데이터베이스 내 사용자를 인증할 수도 있습니다. PLAIN 은(는) 비밀번호를 일반 텍스트로 전송합니다. 이 메커니즘은 MongoDB 엔터프라이즈 및 MongoDB Atlas 에서 사용할 수 있습니다.
MONGODB-OIDC (OpenID Connect)	OpenID Connect를 사용한 외부 인증 . 이 메커니즘은 MongoDB 엔터프라이즈 및 MongoDB Atlas 에서 사용할 수 있습니다.
MONGODB-AWS (Amazon Web Services IAM)	Amazon Web Services Identity and Access Management(Amazon Web Services IAM) 자격 증명 사용한 외부 인증 . 이 메커니즘은 MongoDB 엔터프라이즈 및 MongoDB Atlas 에서 사용할 수 있습니다.

--gssapiServiceName

Specify the name of the service using GSSAPI/Kerberos. Only required if the service does not use the default name of mongodb.

이 옵션은 MongoDB Enterprise에서만 사용할 수 있습니다.

--sspiHostnameCanonicalization <string>

호스트 이름 표준화 사용 여부를 지정합니다.

--sspiHostnameCanonicalization has the same effect as setting the CANONICALIZE_HOST_NAME:true|false key-pair in the authMechanismProperties portion of the connection string.

If --sspiHostnameCanonicalization is set to:

• forwardAndReverse정방향 DNS 조회를 수행한 다음 역방향 조회를 수행합니다. mongosh 1.3.0에 추가되었습니다.

• forwardauthMechanismProperties=CANONICALIZE_HOST_NAME:true 설정과 효과가 동일합니다.

• noneauthMechanismProperties=CANONICALIZE_HOST_NAME:false 설정과 효과가 동일합니다.

--oidcFlows

OpenID Connect 흐름을 쉼표로 구분된 목록으로 지정합니다. OpenID Connect 흐름은 인증 프로세스를 위해 mongosh가 멱등과 상호 작용하는 방법을 지정합니다. mongosh는 다음 OpenID Connect 흐름을 지원합니다.

OpenID 연결 흐름	설명
auth-code	기본값. mongosh를 클릭하면 브라우저가 열리고 멱등 로그인 화면으로 리디렉션됩니다.
device-auth	mongosh 는 인증을 완료하기 위한 URL과 코드를 제공합니다. 이는 보안성이 낮은 OpenID Connect 흐름으로 간주되지만 mongosh가 브라우저를 열 수 없는 환경에서 실행될 때 사용할 수 있습니다

device-auth를 auth-code의 대체 옵션으로 설정하는 방법은 다음 예시에서 확인 가능합니다.

mongosh 'mongodb://localhost/' --authenticationMechanism MONGODB-OIDC --oidcFlows=auth-code,device-auth

--oidcDumpTokens

mongosh가 예비 디버깅 정보가 포함된 토큰을 출력할지 여부를 지정합니다. 이 옵션은 디버깅 용도로만 사용합니다.

--oidcDumpTokens 옵션은 다음과 같은 값을 허용합니다.

값	설명
redacted	--oidcDumpTokens만 설정할 때 기본값입니다. 민감한 정보가 삭제된 상태로 토큰 디버깅 정보를 출력합니다.
include-secrets	데이터베이스 서버에 인증할 수 있는 자격 증명을 포함하여 토큰 디버깅 정보를 출력합니다.

중요

include-secrets 값은 공격자가 인증에 사용할 수 있는 자격 증명을 노출합니다. 권한이 없는 사람이 mongosh의 출력을 볼 수 없고 진단 목적으로 자격 증명이 필요한 경우에만 이 옵션을 사용하세요.

--oidcIdTokenAsAccessToken

mongosh가 자격 증명 공급자로부터 받은 ID 토큰을 액세스 토큰 대신 사용하는지 여부를 지정합니다. JWT 액세스 토큰을 제공하도록 구성할 수 없는 자격 증명 공급자와 함께 이 옵션을 사용합니다.

--oidcNoNonce

기본값으로 mongosh 은 OIDC 권한 부여 코드 흐름 중에 논스 매개 변수를 전송합니다.

--oidcNoNonce 옵션을 설정하다 하면 mongosh 은 논스 매개변수를 전송하지 않습니다. 자격 증명 공급자 가 권한 부여 의 일부로 논스 값을 지원 하지 않는 경우 이 옵션을 사용합니다.

--oidcRedirectUri

인증 후 멱등이 사용자를 리디렉션할 URI를 지정합니다. URI는 멱등의 구성과 일치해야 합니다. 기본값은 http://localhost:27097/redirect입니다.

--oidcTrustedEndpoint

현재 연결이 Atlas 또는 localhost이(가) 아닌 신뢰할 수 있는 엔드포인트에 있음을 나타냅니다. 이렇게 하면 액세스 토큰이 서버 로 전송됩니다. 신뢰할 수 있는 서버에 연결할 때만 이 옵션을 사용합니다.

--browser

MONGODB-OIDC가 활성화된 경우 mongosh가 리디렉션하는 브라우저를 지정합니다.

이 옵션은 시스템 셸에서 실행됩니다.

브라우저 열기를 완전히 비활성화하려면 --no-browser 를 설정합니다.

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

Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the --username and --authenticationDatabase options.

To force the MongoDB Shell to prompt for a password, enter the --password option as the last option and leave out the argument.

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

Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the --password and --authenticationDatabase options.

세션 옵션

--retryWrites

재시도 가능 쓰기를 활성화합니다.

기본적으로 재시도 가능한 쓰기는 다음과 같습니다.

• 활성화됨 mongosh

• 레거시 mongo 셸에서 비활성화됨

To disable retryable writes, use --retryWrites=false.

세션 정보는 클라이언트 세션 및 인과적 일관성 보장에서 확인하세요.

필드 레벨 암호화 옵션

--cryptSharedLibPath <string>

버전 8.2에 추가 되었습니다.

자동 암호화 공유 라이브러리의 경로입니다. 라이브러리는 8 2버전이.. 이상이어야 합니다.0 mongosh 셸 세션에 자동 암호화 사용하는 데 필요합니다.

--awsAccessKeyId <string>

An AWS Access Key associated with an IAM user who has List and Read permissions for the AWS Key Management Service (KMS). mongosh uses the specified --awsAccessKeyId to access the KMS.

--awsAccessKeyId is required to enable Client-Side Field Level Encryption for the mongosh shell session. --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.

To mitigate the risk of leaking access keys into logs, consider specifying an environmental variable to --awsAccessKeyId.

--awsSecretAccessKey <string>

An AWS Secret Key associated to the specified --awsAccessKeyId.

--awsSecretAccessKey is required to enable Client-Side Field Level Encryption for the mongosh session. --awsSecretAccessKey requires both of the following command line options:

• --awsAccessKeyId

• --keyVaultNamespace

If --awsSecretAccessKey and its supporting options are omitted, use Mongo() within the shell session to enable client-side field level encryption.

To mitigate the risk of leaking access keys into logs, consider specifying an environmental variable to --awsSecretAccessKey.

--awsSessionToken <string>

An AWS Session Token associated to the specified --awsAccessKeyId.

--awsSessionToken is required to enable Client-Side Field Level Encryption for the mongosh shell session. --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.

To mitigate the risk of leaking access keys into logs, consider specifying an environmental variable to --awsSessionToken.

--keyVaultNamespace <string>

The full namespace (<database>.<collection>) of the collection used as a key vault for Client-Side Field Level Encryption. --keyVaultNamespace is required for enabling client-side field level encryption for the mongosh shell session. mongosh creates the specified namespace if it does not exist.

--keyVaultNamespace requires both of the following command line options:

• --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.