opciones

Opciones Generales

--build-info

Devuelve un documento con formato JSON con información sobre su mongosh Dependencias de compilación y controlador.

Ejemplo: Ver información de compilación

Se puede verificar la información de compilación y las dependencias de los drivers del binario mongosh ejecutando el siguiente comando desde el terminal:

mongosh --build-info

Este comando devuelve el siguiente documento en formato 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>

Evalúa una expresión de JavaScript. Puedes usar un único argumento --eval o múltiples argumentos --eval juntos.

Después de que mongosh evalúa el argumento --eval, imprime los resultados en la línea de comandos. Si se usan varias instrucciones --eval, mongosh solo imprime los resultados de la última --eval.

Puede utilizar la bandera --json con --eval para devolver mongosh resultados en Formato JSON extendido. mongosh admite --json=canonical --json=relaxed los modos y. Si se omite el modo, mongosh usa el canonical modo por defecto. El --json indicador es mutuamente excluyente --shell con.

Ejemplo: Formato de salida

Para obtener una salida adecuada para el análisis automatizado, utiliza 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

Después de analizar con jq, el resultado se asemeja a esto:

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

Nota

EJSON tiene opciones de formato con funcionalidad incorporada que pueden eliminar la necesidad de un analizador como jq. Por ejemplo, el siguiente código produce una salida que tiene el mismo formato que la anterior.

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

Ejemplo: Múltiples argumentos --eval

Para obtener una lista de colecciones en el moviesDatabase, utiliza varias instrucciones --eval:

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

Ejemplo: opción --json

Para devolver estadísticas sobre una colección en formato JSON extendido utilizando varias instrucciones --eval:

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

--file, -f <javascript>

Ejecuta un script desde la línea de comandos sin entrar en la consola de MongoDB Shell.

Para obtener más detalles y un ejemplo, consulta Ejecutar un script desde la línea de comandos.

--help, -h

Devuelve información sobre las opciones y el uso del MongoDB Shell.

--nodb

Impide que el shell se conecte a cualquier instancia de base de datos.

--no-quiet

Desactiva la opción --quiet por defecto para sesiones de shell no interactivas. Cuando se especifica, mongosh muestra todos los mensajes durante el inicio.

--norc

Impide que el shell cargue y evalúe ~/.mongoshrc.js al iniciar.

--quiet

Omite todos los mensajes durante el inicio (como los mensajes de bienvenida y las advertencias de inicio) y va directamente al prompt.

Para sesiones de shell no interactivas, MongoDB activa --quiet por defecto. Puedes desactivar este comportamiento usando --no-quiet.

--skipStartupWarnings

Evita que mongosh muestre advertencias de inicio del servidor al crear una sesión. Para suprimir todos los mensajes de inicio, utiliza la opción --quiet.

--shell

Activa la interfaz de shell. Si ejecutas el comando mongosh y especificas un archivo JavaScript como argumento, o utilizas --eval para especificar JavaScript en la línea de comandos, la opción --shell proporciona al usuario un indicador de shell después de que el archivo termine de ejecutarse. El indicador --shell es mutuamente excluyente con --json.

--verbose

Incrementa el nivel de verbosidad de la salida del shell durante el proceso de conexión y al ejecutar comandos.

--version

Devuelve el número de versión de MongoDB Shell.

Opciones de Stable API

--apiVersion <version number>

Especifica la apiVersion. "1" es actualmente el único valor compatible.

--apiStrict

Especifica que el servidor responderá con APIStrictError si la aplicación utiliza un comando o comportamiento fuera de la Stable API.

Si se especifica --apiStrict, también debe especificar --apiVersion.

--apiDeprecationErrors

Especifica que el servidor responderá con APIDeprecationError si la aplicación utiliza un comando o comportamiento que está desactualizado en el apiVersion especificado.

Si se especifica --apiDeprecationErrors, también debe especificar --apiVersion.

Opciones de conexión

--host <hostname>

Especifica el nombre de la máquina host donde el mongod o mongos se está ejecutando. Si esto no se especifica, MongoDB Shell intenta conectarse a un proceso de MongoDB que se ejecuta en el localhost.

Para conectarte a un set de réplicas,

Especifica el replica set name y una lista de nodos iniciales del set. Utiliza el siguiente formulario:

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

Para las conexiones TLS/SSL (--tls),

El MongoDB Shell verifica que el nombre de host (especificado en la opción --host o en la cadena de conexión) coincida con el SAN (o, si SAN no está presente, el CN) en el certificado presentado por mongod o mongos. Si SAN está presente, MongoDB Shell no compara CN. Si el nombre de host no coincide con el SAN (o el CN), el shell de MongoDB Shell no se puede conectar.

Para las conexiones de la lista de nodos iniciales de DNS,

Especifique el protocolo de conexión como mongodb+srv, seguido del registro de nombre de host DNS SRV y cualquier opción. Las opciones authSource y replicaSet, si se incluyen en la cadena de conexión, anulan cualquier opción DNS correspondiente configurada en el registro TXT. El uso de la cadena de conexión mongodb+srv: habilita implícitamente TLS/SSL (normalmente configurado tls=true con) para la conexión del cliente. La opción TLS se puede desactivar configurando tls=false en la cadena de consulta.

Ejemplo

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

--port <port>

Especifique el puerto donde la mongod o mongos instancia está escuchando. Si --port no se especifica, MongoDB Shell intenta conectarse al puerto 27017.

Opciones de autenticación

--authenticationDatabase <dbname>

Especifica la base de datos de autenticación donde se ha creado el --username especificado. Consultar la base de datos de autenticación.

Si no especifica un valor para --authenticationDatabase, MongoDB Shell utiliza la base de datos especificada en la cadena de conexión.

--authenticationMechanism <name>

Especifica el mecanismo de autenticación que utiliza MongoDB Shell para autenticarse en el mongod o en el mongos. Si no especificas un authenticationMechanism pero proporcionas las credenciales de usuario, MongoDB Shell y los controladores intentarán usar SCRAM-SHA-256. Si esto falla, recurren a SCRAM-SHA-1.

Valor	Descripción
SCRAM-SHA-1	Solicitud de comentarios 5802 Mecanismo de autenticación de respuesta de desafío salado estándar que utiliza la función hash SHA-1.
SCRAM-SHA-256	RFC 7677 estándar del mecanismo de autenticación de respuesta a desafío salado utilizando la función de hash SHA-256. Se debe establecer featureCompatibilityVersion en 4.0.
MONGODB-X509	Autenticación de certificados TLS / SSL de MongoDB.
GSSAPI (Kerberos)	Autenticación externa utilizando Kerberos. Este mecanismo está disponible solo en MongoDB Enterprise.
PLAIN (SASL LDAP)	Autenticación externa mediante LDAP. También puedes utilizar PLAIN para autenticar a los usuarios de base de datos. PLAIN transmite contraseñas en texto sin formato. Este mecanismo está disponible en MongoDB Enterprise y MongoDB Atlas.
MONGODB-OIDC (OpenID Connect)	Autenticación externa utilizando OpenID Connect. Este mecanismo está disponible en MongoDB Enterprise y MongoDB Atlas.
MONGODB-AWS (AWS IAM)	Autenticación externa mediante credenciales de Amazon Web Services Identity and Access Management (AWS IAM). Este mecanismo está disponible en MongoDB Enterprise y MongoDB Atlas.

--gssapiServiceName

Especifica el nombre del servicio mediante GSSAPI/Kerberos. Solo es necesario si el servicio no utiliza el nombre por defecto de mongodb.

Esta opción solo está disponible en MongoDB Enterprise.

--sspiHostnameCanonicalization <string>

Especifica si se debe utilizar la canonicalización de nombres de host.

--sspiHostnameCanonicalization tiene el mismo efecto que establecer el par de claves CANONICALIZE_HOST_NAME:true|false en la sección authMechanismProperties de la cadena de conexión.

Si --sspiHostnameCanonicalization se establece en:

• forwardAndReverse, realiza una búsqueda directa de DNS y luego una búsqueda inversa. Nuevo en mongosh 1.3.0.

• forward, el efecto es el mismo que al configurar authMechanismProperties=CANONICALIZE_HOST_NAME:true.

• none, el efecto es el mismo que al configurar authMechanismProperties=CANONICALIZE_HOST_NAME:false.

--oidcFlows

Especifica los flujos de OpenID Connect en una lista separada por comas. Los flujos de OpenID Connect especifican la interacción de mongosh con el proveedor de identidad para el proceso de autenticación. mongosh admite los siguientes flujos de OpenID Connect:

Flujo de OpenID Connect	Descripción
auth-code	Por defecto. mongosh abre un navegador y hace el redireccionamiento a la pantalla para iniciar sesión del proveedor de identidad.
device-auth	mongosh te proporciona una URL y un código para completar la autenticación. Esto se considera un flujo de OpenID Connect menos seguro, pero se puede utilizar cuando mongosh se ejecuta en un entorno en el que no se puede abrir un navegador.

Para establecer device-auth como opción de respaldo para auth-code, consulta el siguiente ejemplo:

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

--oidcDumpTokens

Especifica si mongosh imprime tokens con información extra de depuración. Utiliza esta opción solo para fines de depuración.

La opción --oidcDumpTokens acepta los siguientes valores:

Valor	Descripción
redacted	Por defecto cuando solo se configura --oidcDumpTokens. Imprime la información de depuración de tokens con los datos sensibles redactados.
include-secrets	Imprime información de depuración de tokens, incluidas las credenciales que podrían autenticar potencialmente a los servidores de bases de datos.

Importante

El valor include-secrets expone credenciales que los atacantes pueden usar para la autenticación. Utilice esta opción solo cuando las personas no autorizadas no puedan ver el resultado de mongosh y las credenciales sean necesarias para fines de diagnóstico.

--oidcIdTokenAsAccessToken

Especifica si mongosh utiliza el token de ID recibido del proveedor de identidad en lugar del token de acceso. Utiliza esta opción con proveedores de identidad que no puedas configurar para proporcionar tokens de acceso JWT.

--oidcNoNonce

Por defecto, mongosh envía un parámetro nonce durante el flujo de código de autorización de OIDC.

Si se establece la opción --oidcNoNonce, mongosh no envía un parámetro nonce. Se debe usar esta opción si el proveedor de identidad no admite valores nonce como parte de la autorización.

--oidcRedirectUri

Especifica una URI donde el proveedor de identidad redirige después de la autenticación. La URI debe coincidir con la configuración del proveedor de identidad. El valor es por defecto http://localhost:27097/redirect.

--oidcTrustedEndpoint

Indica que la conexión actual es a un punto final confiable que no es Atlas ni localhost. Esto asegura que los tokens de acceso sean enviados al servidor. Se debe usar esta opción solo cuando se realice la conexión a servidores en los que se confíe.

--browser

Especifica el navegador al que mongosh redirige cuando MONGODB-OIDC está activado.

Esta opción se ejecuta con el shell del sistema.

Establece --no-browser para desactivar la apertura de navegadores por completo.

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

Especifica una contraseña con la que autenticarse en una base de datos de MongoDB que utiliza autenticación. Utiliza en conjunto con las --username y --authenticationDatabase opciones.

Para forzar que MongoDB Shell solicite una contraseña, introduce la opción --password como última opción y omite el argumento.

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

Especifica un nombre de usuario con el cual autenticarte en una base de datos MongoDB que utiliza autenticación. Utilízalo en conjunto con las --password y --authenticationDatabase opciones.

Opciones de sesión

--retryWrites

Activa Escrituras reintentables.

Por defecto, las escrituras reintentables son:

• activado en mongosh

• desactivado en el shell mongo heredado

Para desactivar las escrituras reintentables, utiliza --retryWrites=false.

Para obtener más información sobre las sesiones, consulta Sesiones de cliente y garantías de coherencia causal.

Opciones de cifrado a nivel de campo

--cryptSharedLibPath <string>

Nuevo en la versión 8.2.

La ruta a la Biblioteca compartida de cifrado automático. La biblioteca debe ser versión 8.2.0 o superior. Es necesario utilizar el cifrado automático para la sesión del shell mongosh.

--awsAccessKeyId <string>

Una clave de acceso de AWS asociada con un usuario de IAM que tiene permisos List y Read para el Key Management Service (KMS) de AWS. mongosh utiliza el --awsAccessKeyId especificado para acceder al KMS.

--awsAccessKeyId es necesario para activar el cifrado a nivel de campo del lado del cliente para la sesión de shell de mongosh. --awsAccessKeyId requiere ambas de las siguientes opciones de línea de comandos:

• --awsSecretAccessKey

• --keyVaultNamespace

Si se omite --awsAccessKeyId, utiliza el constructor Mongo() dentro de la sesión de shell para activar el cifrado a nivel de campo del lado del cliente.

Para mitigar el riesgo de filtración de claves de acceso en los registros, considera especificar una variable de entorno para --awsAccessKeyId.

--awsSecretAccessKey <string>

Una clave secreta de AWS asociada al --awsAccessKeyId especificado.

Se requiere --awsSecretAccessKey para activar el cifrado a nivel de campo del lado del cliente para la sesión de mongosh. --awsSecretAccessKey requiere ambas de las siguientes opciones de línea de comandos:

• --awsAccessKeyId

• --keyVaultNamespace

Si --awsSecretAccessKey y tus opciones de soporte se omiten, utiliza Mongo() dentro de la sesión del shell para activar el cifrado a nivel de campo del lado del cliente.

Para mitigar el riesgo de filtración de claves de acceso en los registros, considera especificar una variable de entorno para --awsSecretAccessKey.

--awsSessionToken <string>

Un Token de sesión de AWS asociado a la --awsAccessKeyIdespecificada.

--awsSessionToken es necesario para activar el cifrado a nivel de campo del lado del cliente para la sesión de shell de mongosh. --awsSessionToken requiere todas las siguientes opciones de línea de comandos:

• --awsAccessKeyId

• --awsSecretAccessKey

• --keyVaultNamespace

Si --awsSessionToken y tus opciones de soporte se omiten, utiliza Mongo() dentro de la sesión del shell para activar el cifrado a nivel de campo del lado del cliente.

Para mitigar el riesgo de filtración de claves de acceso en los registros, considera especificar una variable de entorno para --awsSessionToken.

--keyVaultNamespace <string>

El namespace completo (<database>.<collection>) de la colección utilizada como almacén de claves para el cifrado a nivel de campo del lado del cliente. Se requiere --keyVaultNamespace para activar el cifrado a nivel de campo del lado del cliente para la sesión de shell mongosh. mongosh crea el namespace especificado si no existe.

--keyVaultNamespace requiere ambas de las siguientes opciones de línea de comandos:

• --awsAccessKeyId

• --awsSecretAccessKey

Si --keyVaultNamespace y sus opciones de soporte se omiten, utiliza el constructor Mongo() dentro de la sesión de shell para activar el cifrado a nivel de campo del lado del cliente.