Opções

Opções gerais

--build-info

Retorna um documento formatado em JSON com informações sobre suas mongosh dependências build e driver.

Exemplo: visualizar informações de compilação

Você pode verificar as informações de compilação e as dependências do driver do seu binário mongosh executando o seguinte comando no seu terminal:

mongosh --build-info

Este comando retorna o seguinte documento formatado em 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>

Avalia uma expressão JavaScript. Você pode usar um único argumento --eval ou múltiplos argumentos --eval juntos.

Após o mongosh avaliar o argumento --eval, ele imprime os resultados para sua linha de comando. Se você usar várias instruções --eval, mongosh imprimirá somente os resultados do último --eval.

Você pode usar a sinalização --json com --eval para retornar resultados de mongosh no formato Extended JSON. mongosh suporta os modos --json=canonical e --json=relaxed . Se você omitir o modo, mongosh assumirá como padrão o modo canonical. A sinalização --json é mutuamente exclusiva com --shell.

Exemplo: Formatar saída

Para obter uma saída adequada para análise automatizada, use 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

Após analisar com jq, a saída se assemelha a isto:

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

Observação

EJSON criou opções de formatação que podem eliminar a necessidade de um analisador como jq. Por exemplo, o código a seguir produz uma saída formatada da mesma forma que a anterior.

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

Exemplo: vários argumentos --eval

Para obter uma lista de coleções no moviesDatabase, utilize múltiplas declarações do --eval:

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

Exemplo: opção --json

Para retornar estatísticas sobre uma coleção no formato JSON estendido usando múltiplas instruções --eval:

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

--file, -f <javascript>

Executa um roteiro da linha de comando sem inserir o console do MongoDB Shell.

Para obter detalhes adicionais e um exemplo, consulte Executar um roteiro a partir da linha de comando.

--help, -h

Retorna informações sobre as opções e uso do MongoDB Shell.

--nodb

Impede que o shell se conecte a quaisquer instâncias do banco de dados.

--no-quiet

Desabilita o --quiet modo de opção padrão para sessões de shell não interativas. Quando especificado, mongosh exibe todas as mensagens durante a inicialização.

--norc

Impede que o shell forneça e avalie ~/.mongoshrc.js na inicialização.

--quiet

Ignora todas as mensagens durante a inicialização (como mensagens de boas-vindas e avisos de inicialização) e vai diretamente para o prompt.

Para sessões de shell não interativas, o MongoDB habilita o --quiet por padrão. Você pode desabilitar este comportamento --no-quiet utilizando.

--skipStartupWarnings

Impede mongosh que exiba avisos de inicialização do servidor ao criar uma sessão. Para suprimir todas as mensagens de inicialização, use a --quiet opção.

--shell

Habilita a interface shell. Se você invocar o comando mongosh e especificar um arquivo JavaScript como argumento ou usar --eval para especificar o JavaScript na linha de comando, a opção --shell fornecerá ao usuário um prompt de shell após o arquivo finalizar a execução. A sinalização --shell é mutuamente exclusiva com --json.

--verbose

Aumenta a verbosidade da saída de shell durante o processo de conexão e ao executar comandos.

--version

Retorna o número de versão do MongoDB Shell.

Opções de API estáveis

--apiVersion <version number>

Especifica a apiVersion. "1" é atualmente o único valor compatível.

--apiStrict

Especifica que o servidor responderá com APIStrictError se seu aplicativo utilizar um comando ou comportamento fora da Stable API.

Ao especificar --apiStrict, você também deverá especificar --apiVersion.

--apiDeprecationErrors

Especifica que o servidor responderá com APIDeprecationError se seu aplicativo utilizar um comando ou comportamento que é preterido no apiVersion especificado.

Ao especificar --apiDeprecationErrors, você também deverá especificar --apiVersion.

Opções de conexão

--host <hostname>

Especifica o nome da máquina host onde o mongod ou mongos está sendo executado. Se isso não for especificado, o MongoDB Shell tentará se conectar a um processo MongoDB em execução no localhost.

Para se conectar a um conjunto de réplicas,

Especifique o replica set name e uma lista inicial dos membros do conjunto. Use o seguinte formulário:

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

Para conexões TLS/SSL (--tls),

O MongoDB Shell verifica se o nome do host (especificado na opção --host ou na string de conexão) corresponde ao SAN (ou, se SAN não estiver presente, o CN) no certificado apresentado pelo mongod ou mongos. Se SAN estiver presente, o MongoDB Shell não corresponderá ao CN. Se o nome do host não corresponder ao SAN (ou ao CN), o shell do MongoDB Shell não conseguirá se conectar.

Para conexões de lista de seeds DNS,

Especifique o protocolo de conexão como mongodb+srv, seguido pelo registro de nome de host SRV DNS e quaisquer opções. As opções authSource e replicaSet, se incluídas na connection string, substituem quaisquer opções correspondentes configuradas pelo DNS definidas no registro TXT. O uso da connection string mongodb+srv: habilita implicitamente TLS / SSL (normalmente definido com tls=true) para a conexão do cliente. A opção TLS pode ser desativada configurando o tls=false na string de query.

Exemplo

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

--port <port>

Especifica a porta em que a instância do mongod ou mongos está escutando. Se --port não for especificado, o MongoDB Shell tentará se conectar à porta 27017.

Opções de autenticação

--authenticationDatabase <dbname>

Especifica o banco de dados de autenticação onde o --username especificado foi criado. Consulte Banco de dados de autenticação.

Se você não especificar um valor para --authenticationDatabase, o MongoDB Shell utilizará o banco de dados especificado na string de conexão.

--authenticationMechanism <name>

Especifica o mecanismo de autenticação que o MongoDB Shell utiliza para autenticar no mongod ou mongos. Se você não especificar um authenticationMechanism, mas fornecer credenciais de usuário, o MongoDB Shell e os drivers tentarão utilizar SCRAM-SHA-256. Se isso falhar, eles voltarão para SCRAM-SHA-1.

Valor	Descrição
SCRAM-SHA-1	RFC 5802 mecanismo de autenticação de resposta de desafio salgado padrão usando a função de hash SHA-1.
SCRAM-SHA-256	RFC 7677 mecanismo de autenticação de resposta de desafio salgado padrão usando a função de hash SHA-256. Exige featureCompatibilityVersion definido para 4.0.
MONGODB-X509	Autenticação do certificado TLS / SSL do MongoDB.
GSSAPI (Kerberos)	Autenticação externa usando Kerberos. Esse mecanismo está disponível somente no MongoDB Enterprise.
PLAIN (LDAP SASL)	Autenticação externa usando LDAP. Você também pode utilizar o PLAIN para autenticar usuários do banco de dados. PLAIN transmite senhas em texto simples. Este mecanismo está disponível em MongoDB Enterprise e MongoDB Atlas.
MONGODB-OIDC (OpenID connect)	Autenticação externa usando OpenID Connect. Este mecanismo está disponível em MongoDB Enterprise e MongoDB Atlas.
MONGODB-AWS (Amazon Web Services IAM)	Autenticação externa usando credenciais do Amazon Web Services Identity and Access Management (Amazon Web Services IAM). Este mecanismo está disponível em MongoDB Enterprise e MongoDB Atlas.

--gssapiServiceName

Especifique o nome do serviço utilizando GSSAPI/Kerberos. Obrigatório apenas se o serviço não usar o nome padrão mongodb.

Esta opção está disponível apenas no MongoDB Enterprise.

--sspiHostnameCanonicalization <string>

Especifica se deseja ou não usar a Canonicalização de nome de host.

--sspiHostnameCanonicalization tem o mesmo efeito que definir o par de chave CANONICALIZE_HOST_NAME:true|false na parte authMechanismProperties da string de conexão.

Se o --sspiHostnameCanonicalization estiver configurado para:

• forwardAndReverse, realiza uma pesquisa direta de DNS e, em seguida, uma pesquisa inversa. Novidade em mongosh 1,3,0.

• forward, o efeito é o mesmo que definir authMechanismProperties=CANONICALIZE_HOST_NAME:true.

• none, o efeito é o mesmo que definir authMechanismProperties=CANONICALIZE_HOST_NAME:false.

--oidcFlows

Especifica fluxos OpenID Connect em uma lista separada por vírgula. Os fluxos do OpenID Connect especificam como o mongosh interage com o provedor de identidade para o processo de autenticação. O mongosh suporta os seguintes fluxos OpenID Connect:

Fluxo de conexão OpenID	Descrição
auth-code	Padrão. mongosh abre um navegador e redireciona você para a tela de login do provedor de identidade.
device-auth	mongosh fornece um URL e um código para concluir a autenticação. Esse é considerado um fluxo OpenID Connect menos seguro, mas pode ser usado quando mongosh é executado em um ambiente no qual não é possível abrir um navegador.

Para configurar o device-auth como uma opção de contingência para auth-code, consulte o seguinte exemplo:

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

--oidcDumpTokens

Especifica se o mongosh imprime tokens com informações de depuração extras. Use essa opção apenas para fins de depuração.

A opção --oidcDumpTokens aceita os seguintes valores:

Valor	Descrição
redacted	Padrão quando você apenas define --oidcDumpTokens. Imprime informações de depuração de token com dados confidenciais ocultados.
include-secrets	Imprime informações de depuração de token, incluindo credenciais que podem autenticar em servidores de banco de dados .

Importante

O valor include-secrets expõe credenciais que os invasores podem utilizar para autenticação. Use essa opção somente quando pessoas não autorizadas não puderem visualizar a saída de mongosh e as credenciais forem necessárias para fins de diagnóstico.

--oidcIdTokenAsAccessToken

Especifica se mongosh utiliza o token de ID recebido do provedor de identidade ao invés do token de acesso. Use esta opção com provedores de identidade que você não consegue configurar para fornecer tokens de acesso JWT.

--oidcNoNonce

Por padrão, mongosh envia um parâmetro nonce durante o fluxo de código de autorização do OIDC.

Se você configurar a opção --oidcNoNonce, o mongosh não enviará um parâmetro nonce. Use essa opção se o seu provedor de identidade não oferecer suporte a valores únicos como parte da autorização.

--oidcRedirectUri

Especifica um URI em que o provedor de identidade redireciona você após a autenticação. O URI deve corresponder à configuração do provedor de identidade. O padrão é http://localhost:27097/redirect.

--oidcTrustedEndpoint

Indica que a conexão atual é para um endpoint confiável que não é Atlas ou localhost. Isso garante que os tokens de acesso sejam enviados ao servidor. Use essa opção somente ao se conectar a servidores nos quais você confia.

--browser

Especifica o navegador mongosh redireciona você para quando MONGODB-OIDC está habilitado.

Esta opção é executada com o shell do sistema.

Defina --no-browser para desativar totalmente a abertura de navegadores.

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

Especifica uma senha com a qual autenticar em um MongoDB database que usa autenticação. Utilize em conjunto com as opções --username e --authenticationDatabase.

Para forçar o MongoDB Shell a solicitar uma senha, digite a opção --password como a última opção e deixe de fora o argumento.

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

Especifica um nome de usuário com o qual autenticar em um banco de dados MongoDB que usa autenticação. Utilize em conjunto com as opções --password e --authenticationDatabase.

Opções de sessão

--retryWrites

Permite gravações repetíveis.

Por padrão, as gravações que podem ser repetidas são:

• habilitado em mongosh

• desabilitados no shell mongo legado

Para desativar gravações repetíveis, use --retryWrites=false.

Para obter mais informações sobre sessões, consulte Sessões de clientes e garantias de consistência causal.

Opções de criptografia em nível de campo

--cryptSharedLibPath <string>

Novidades na versão 8.2.

O caminho para a Biblioteca compartilhada de criptografia automática. A biblioteca deve ser da versão 8.2.0 ou superior. Necessário para utilizar criptografia automática para a mongosh sessão de shell do.

--awsAccessKeyId <string>

Uma chave de acesso da AWS associada a um usuário do IAM que tem as permissões List e Read para o AWS Key Management Service (KMS). mongosh usa o --awsAccessKeyId especificado para acessar o KMS.

--awsAccessKeyId é necessário para habilitar a criptografia em nível de campo do lado do cliente para a sessão do shell mongosh. --awsAccessKeyId exige ambas as seguintes opções de linha de comando:

• --awsSecretAccessKey

• --keyVaultNamespace

Se --awsAccessKeyId for omitido, use o construtor Mongo() na sessão do shell para ativar a criptografia em nível de campo no lado do cliente.

Para mitigar o risco de vazamento de chaves de acesso em logs, considere especificar uma variável ambiental para --awsAccessKeyId.

--awsSecretAccessKey <string>

Uma chave secreta da AWS associada ao --awsAccessKeyIdespecificado.

--awsSecretAccessKey é necessário para ativar Criptografia de nível de campo do lado do cliente para a sessão mongosh. --awsSecretAccessKey exige ambas as seguintes opções de linha de comando:

• --awsAccessKeyId

• --keyVaultNamespace

Se o --awsSecretAccessKey e suas opções de compatibilidade forem omitidas, utilize o Mongo() dentro da sessão de shell para habilitar a criptografia de nível de campo do lado do cliente.

Para mitigar o risco de vazamento de chaves de acesso em logs, considere especificar uma variável ambiental para --awsSecretAccessKey.

--awsSessionToken <string>

Um Amazon Web Services Session Token associado ao --awsAccessKeyIdespecificado.

--awsSessionToken é necessário para habilitar a criptografia no nível do campo do lado do cliente para a sessão do shell mongosh. --awsSessionToken requer todas as seguintes opções de linha de comando:

• --awsAccessKeyId

• --awsSecretAccessKey

• --keyVaultNamespace

Se o --awsSessionToken e suas opções de compatibilidade forem omitidas, utilize o Mongo() dentro da sessão de shell para habilitar a criptografia de nível de campo do lado do cliente.

Para mitigar o risco de vazamento de chaves de acesso em logs, considere especificar uma variável ambiental para --awsSessionToken.

--keyVaultNamespace <string>

O namespace completo (<database>.<collection>) da coleção usado como um cofre de chaves para criptografia no nível do campo do lado do cliente. --keyVaultNamespace é necessário para habilitar a criptografia em nível de campo do lado do cliente para a sessão do shell mongosh. mongosh cria o namespace especificado se ele não existir.

--keyVaultNamespace exige ambas as opções de linha de comando a seguir:

• --awsAccessKeyId

• --awsSecretAccessKey

Se o --keyVaultNamespace e suas opções de compatibilidade forem omitidas, utilize o construtor Mongo() dentro da sessão de shell para habilitar a criptografia de nível de campo do lado do cliente.