mongoexport

Synopsis

mongoexport es una herramienta de base de datos que produce una exportación JSON o CSV de datos almacenados en una instancia de MongoDB.

Ejecute mongoexport desde la línea de comandos del sistema, no desde el mongo caparazón.

mongoexport no es una herramienta para respaldar implementaciones. Si deseas crear una solución de copia de seguridad, consulta Respaldo y restauración de una implementación autogestionada con las herramientas de MongoDB.

Puedes usar los MongoDB Database Tools para migrar de una implementación autoalojada a MongoDB Atlas. MongoDB Atlas es el servicio totalmente gestionado para las implementaciones de MongoDB en la nube. Para aprender más, consulta Seed con mongorestore.

Para aprender todas las formas en que puede migrar a MongoDB Atlas, consulte Migrar o importar datos.

Sintaxis

mongoexport sintaxis:

mongoexport --collection=<coll> <options> <connection-string>

Se debe especificar la collection a exportar. Si no se especifica un output file, mongoexport guarda en la salida estándar (por ejemplo, stdout).

mongoexport --collection=events --db=reporting --out=events.json

opciones

--help

Devuelve información sobre las opciones y el uso de mongoexport.

--verbose, -v

Aumenta la cantidad de reportes internos devueltos en la salida estándar o en las entradas de registro. Aumenta el nivel de verbosidad con la forma -v incluyendo la opción varias veces (por ejemplo, -vvvvv.)

--quiet

Ejecuta mongoexport en modo silencioso que intenta limitar la cantidad de salida.

Esta opción suprime:

• Salida de comandos de base de datos

• Actividad de replicación

• Eventos de conexión aceptada y cerrada

• Todos los registros, incluidos los mensajes de error, excepto aquellos que ocurren al analizar las opciones

--version

Devuelve el número de la versión mongoexport.

--config=<filename>

Nuevo en la versión 100.3.0.

Especifica la ruta completa a un archivo de configuración YAML que contiene valores confidenciales para las siguientes opciones mongoexport:

• --password

• --uri

• --sslPEMKeyPassword

Esta es la forma recomendada de especificar una contraseña para mongoexport, además de especificarla mediante una solicitud de contraseña. Puedes utilizar cualquier combinación de los argumentos en el archivo.

El archivo de configuración tiene la siguiente estructura:

password: <password>
uri: mongodb://mongodb0.example.com:27017
sslPEMKeyPassword: <password>

Si especifica la opción password sin especificar uri, puede especificar los otros componentes de la cadena de conexión utilizando las opciones de línea de comandos mongoexport, como --username y --host.

Asegúrate de proteger este archivo con los permisos adecuados del sistema de archivos.

Importante

Al utilizar la opción --config, ten en cuenta las siguientes limitaciones y comportamientos:

• Si proporcionas el campo password y una cadena de conexión en el campo uri con una contraseña conflictiva, mongorestore resultará en un error.

• Si especifica un archivo de configuración con --config y también utiliza las opciones de línea de comandos --password, --uri o --sslPEMKeyPassword mongoexport, la opción de línea de comandos anulará la opción correspondiente del archivo de configuración.

--uri=<connectionString>

Especifica la cadena de conexión URI resoluble de la implementación de MongoDB, entre comillas:

--uri="mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]"

A partir de la versión 100.0 de mongoexport, la cadena de conexión puede proporcionarse alternativamente como un parámetro posicional, sin utilizar la opción --uri:

mongoexport mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]

Como parámetro de posicionamiento, la cadena de conexión puede especificarse en cualquier punto de la línea de comandos, siempre que comience con mongodb:// o mongodb+srv://. Por ejemplo:

mongoexport --username joe --password secret1 mongodb://mongodb0.example.com:27017 --ssl

Solo se puede proporcionar una cadena de conexión. Intentar incluir más de uno, ya sea utilizando la opción --uri o como argumento posicional, resultará en un error.

Para obtener información sobre los componentes de la cadena de conexión, consulta la documentación del formato URI de la cadena de conexión.

Nota

Algunos componentes en el connection string pueden especificarse alternativamente utilizando sus propias opciones explícitas de línea de comandos, como --username y --password. El proveer una cadena de conexión, mientras también se utiliza una opción explícita y se especifica información conflictiva, resultará en error.

Nota

Si se usa mongoexport en Ubuntu 18.04, se puede recibir un mensaje de error cannot unmarshal DNS al usar cadenas de conexión SRV (en el formato mongodb+srv://) con la opción --uri. Si es así, se debe usar una de las siguientes opciones en su lugar:

• la opción --uri con una cadena de conexión no SRV (en la forma mongodb://)

• la opción --host para especificar el host al cual conectarse directamente

Advertencia

En algunos sistemas, una contraseña proporcionada en una cadena de conexión con la opción --uri puede ser visible para programas de estado del sistema como ps que pueden ser invocados por otros usuarios. Considera en cambio:

• omitir la contraseña en la cadena de conexión para recibir un aviso interactivo de contraseña, o

• utilizando la opción --config para especificar un archivo de configuración que contenga la contraseña.

--host=<hostname><:port>, -h=<hostname><:port>

Por defecto: localhost:27017

Especifica el nombre de host resoluble de la implementación de MongoDB. Por defecto, mongoexport intenta conectarse a una instancia de MongoDB que se ejecuta en el host local en el número de puerto 27017.

Para conectarse a un set de réplicas, especifica el replSetName y una lista de nodos iniciales de los miembros del set, tal como se muestra a continuación:

--host=<replSetName>/<hostname1><:port>,<hostname2><:port>,<...>

Al especificar el formato de la lista del set de réplicas, mongoexport siempre se conecta al primario.

También puedes conectarte a cualquier Nodo individual del Set de réplicas especificando el host y el puerto de solo ese Nodo:

--host=<hostname1><:port>

Si utilizas IPv6 y el formato <address>:<port>, debes encerrar la parte de una combinación de dirección y puerto entre corchetes (por ejemplo, [<address>]).

Alternativamente, también puedes especificar el nombre de host directamente en el URI connection string. El ofrecer una cadena de conexión, mientras también se utiliza --host y ademas se especifica información conflictiva, resultará en error.

--port=<port>

Por defecto: 27017

Especifica el puerto TCP en el que la instancia de MongoDB escucha las conexiones de los clientes.

Alternativamente, también puedes especificar el puerto directamente en la URI connection string. Proveer una cadena de conexión, mientras también se utiliza --port y se especifica información conflictiva, dará como resultado un error.

--ssl

Permite la conexión a un mongod o a un mongos que tenga habilitado el soporte de TLS/SSL.

Alternativamente, también puedes configurar el soporte TLS/SSL directamente en el URI connection string. Proveer una cadena de conexión, mientras también se utiliza --ssl y se especifica información conflictiva, resultará en error.

Para obtener más información sobre TLS/SSL y MongoDB, consulta Configurar mongod y mongos para TLS/SSL y Configuración de TLS/SSL para clientes.

--sslCAFile=<filename>

Especifica el archivo .pem que contiene la cadena de certificados raíz de la Autoridad Certificadora. Especifica el nombre del archivo .pem con rutas relativas o absolutas.

Alternativamente, también puedes especificar el archivo .pem directamente en la URI connection string. Proveer una cadena de conexión, mientras también se utiliza --sslCAFile y se especifica información conflictiva, resultará en error.

Para obtener más información sobre TLS/SSL y MongoDB, consulta Configurar mongod y mongos para TLS/SSL y Configuración de TLS/SSL para clientes.

--sslPEMKeyFile=<filename>

Especifica el archivo .pem que contiene tanto el certificado TLS/SSL como la clave. Especifica el nombre del archivo .pem con rutas relativas o absolutas.

Esta opción es obligatoria cuando se utiliza la opción --ssl para conectarse a un mongod o mongos que tiene CAFile habilitado sin allowConnectionsWithoutCertificates.

Alternativamente, también puedes especificar el archivo .pem directamente en la URI connection string. Proveer una cadena de conexión, mientras también se utiliza --sslPEMKeyFile y se especifica información conflictiva, resultará en error.

Para obtener más información sobre TLS/SSL y MongoDB, consulta Configurar mongod y mongos para TLS/SSL y Configuración de TLS/SSL para clientes.

--sslPEMKeyPassword=<value>

Especifica la contraseña para descifrar el archivo de clave del certificado (es decir, --sslPEMKeyFile). Utiliza la opción --sslPEMKeyPassword solo si el archivo de clave del certificado está cifrado. En todos los casos, el mongoexport ocultará la contraseña de todos los registros y reportes de salida.

Si la llave privada en el archivo PEM está cifrada y no se especifica la opción --sslPEMKeyPassword, el mongoexport solicitará una frase de contraseña. Consultar la frase de contraseña del certificado TLS/SSL.

Alternativamente, también puedes especificar la contraseña directamente en la URI connection string. El ofrecer una cadena de conexión, mientras también se utiliza --sslPEMKeyPassword y ademas se especifica información conflictiva, resultará en error.

Para obtener más información sobre TLS/SSL y MongoDB, consulta Configurar mongod y mongos para TLS/SSL y Configuración de TLS/SSL para clientes.

Advertencia

En algunos sistemas, una contraseña proporcionada directamente mediante la opción --sslPEMKeyPassword puede ser visible para los programas de estado del sistema, como ps, que pueden ser invocados por otros usuarios. En su lugar, considera usar la opción --config para especificar un archivo de configuración que contenga la contraseña.

--sslCRLFile=<filename>

Especifica el archivo .pem que contiene la Lista de revocación de certificados. Especifica el nombre del archivo .pem con rutas relativas o absolutas.

Para obtener más información sobre TLS/SSL y MongoDB, consulta Configurar mongod y mongos para TLS/SSL y Configuración de TLS/SSL para clientes.

--sslAllowInvalidCertificates

Omite las comprobaciones de validación de los certificados de servidor y permite el uso de certificados no válidos. Si utilizas la configuraciónallowInvalidCertificates, MongoDB realiza un registro como advertencia del uso del certificado no válido.

Advertencia

Aunque está disponible, evita utilizar la opción --sslAllowInvalidCertificates en lo posible. Si necesitas usar --sslAllowInvalidCertificates, utiliza únicamente la opción en los sistemas donde no sea posible la intrusión.

Conectarse a una instancia mongod o mongos sin validar los certificados del servidor es un riesgo potencial para la seguridad. Si solo necesitas deshabilitar la validación del nombre de host en los certificados TLS/SSL, consulta --sslAllowInvalidHostnames.

Alternativamente, también puedes deshabilitar la validación del certificado directamente en la URI connection string. Proveer una cadena de conexión, mientras también se utiliza --sslAllowInvalidCertificates y se especifica información conflictiva, resultará en error.

Para obtener más información sobre TLS/SSL y MongoDB, consulta Configurar mongod y mongos para TLS/SSL y Configuración de TLS/SSL para clientes.

--sslAllowInvalidHostnames

Desactiva la validación de los nombres de host en los certificados TLS/SSL. Permite a mongoexport conectarse a instancias de MongoDB incluso si el nombre de host en sus certificados no coincide con el nombre de host especificado.

Como alternativa, también puedes desactivar la validación del nombre de host directamente en la URI connection string. El ofrecer una cadena de conexión, mientras también se utiliza --sslAllowInvalidHostnames y ademas se especifica información conflictiva, resultará en error.

Para obtener más información sobre TLS/SSL y MongoDB, consulta Configurar mongod y mongos para TLS/SSL y Configuración de TLS/SSL para clientes.

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

Alternativamente, también puede especificar el nombre de usuario directamente en el URI connection string. Proporcionar una cadena de conexión mientras también se utiliza --username y especificar información conflictiva resultará en un error.

Si se realiza la conexión a un clúster de MongoDB Atlas con el MONGODB-AWS authentication mechanism, se puede especificar la ID de clave de acceso de AWS en:

• este campo,

• la connection string o

• la variable de entorno AWS_ACCESS_KEY_ID.

Consulta Conectar a un clúster de MongoDB Atlas usando credenciales de AWS IAM para obtener un ejemplo de cada uno.

--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 solicitar la contraseña al usuario, pasar la opción --username sin --password o especificar una string vacía como valor de --password, como en --password "" .

Alternativamente, también puedes especificar la contraseña directamente en la URI connection string. El ofrecer una cadena de conexión, mientras también se utiliza --password y ademas se especifica información conflictiva, resultará en error.

Si se realiza la conexión a un clúster MongoDB Atlas con el authentication mechanism de MONGODB-AWS, se puede especificar la clave de acceso secreta de AWS en:

• este campo,

• la connection string o

• la variable de entorno AWS_SECRET_ACCESS_KEY.

Consulta Conectar a un clúster de MongoDB Atlas usando credenciales de AWS IAM para obtener un ejemplo de cada uno.

Advertencia

En algunos sistemas, una contraseña proporcionada directamente mediante la opción --password puede ser visible para programas de estado del sistema, como ps, que pueden ser invocados por otros usuarios. Considera en cambio:

• omitiendo la opción --password para recibir una solicitud interactiva de contraseña, o

• utilizando la opción --config para especificar un archivo de configuración que contenga la contraseña.

--awsSessionToken=<AWS Session Token>

Si se realiza la conexión a un clúster de MongoDB Atlas con el authentication mechanism de MONGODB-AWS y se usan tokens de sesión además de la ID de clave de acceso de AWS y la clave de acceso secreta, se puede especificar el token de sesión de AWS en:

• este campo,

• el parámetro AWS_SESSION_TOKEN authMechanismProperties para el connection string, o

• la variable de entorno AWS_SESSION_TOKEN.

Consulta Conectar a un clúster de MongoDB Atlas usando credenciales de AWS IAM para obtener un ejemplo de cada uno.

Solo válido cuando se utiliza el MONGODB-AWS authentication mechanism.

--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 especificas una base de datos de autenticación, mongoexport asume que la base de datos especificada para exportar contiene las credenciales del usuario.

Si utiliza GSSAPI (Kerberos), PLAIN (LDAP SASL) o MONGODB-AWS authentication mechanisms, deberá configurar --authenticationDatabase a $external.

Alternativamente, también puedes especificar la base de datos de autenticación directamente en la URI connection string. El ofrecer una cadena de conexión, mientras también se utiliza --authenticationDatabase y ademas se especifica información conflictiva, resultará en error.

--authenticationMechanism=<name>

Por defecto: SCRAM-SHA-1

Especifica el mecanismo de autenticación que la instancia mongoexport utiliza para autenticarse en el mongod o en el mongos.

Cambiado en la versión 100.1.0: A partir de la versión 100.1.0, mongoexport agrega soporte para el mecanismo de autenticación MONGODB-AWS al conectarse a un clúster de MongoDB Atlas.

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-X.509	Autenticación de certificados TLS/SSL de MongoDB.
MONGODB-AWS	Autenticación externa utilizando credenciales de AWS IAM para conectarse a un clúster de MongoDB Atlas. Consulte Conéctese a un clúster de MongoDB Atlas usando credenciales de AWS IAM. Nuevo en la versión 100.1.0.
GSSAPI (Kerberos)	Autenticación externa mediante Kerberos. Este mecanismo solo está disponible 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 plano. Este mecanismo solo está disponible en MongoDB Enterprise.

Alternativamente, también puedes especificar el mecanismo de autenticación directamente en la URI connection string. Proveer una cadena de conexión, mientras también se utiliza --authenticationMechanism y se especifica información conflictiva, resultará en error.

--gssapiServiceName=<serviceName>

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.

--gssapiHostName=<hostname>

Especifica el nombre de host de un servicio utilizando GSSAPI/Kerberos. Solo es necesario si el nombre de host de una máquina no coincide con el nombre de host resuelto por DNS.

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

--db=<database>, -d=<database>

Especifica el nombre de la base de datos en la que se ejecutará mongoexport.

Alternativamente, también puedes especificar la base de datos directamente en la URI connection string. Proveer una cadena de conexión, mientras también se utiliza --db y ademas se especifica información conflictiva, resultará en error.

--collection=<collection>, -c=<collection>

Especifica la colección que se exportará.

--fields=<field1[,field2]>, -f=<field1[,field2]>

Especifica un campo o campos para incluir en la exportación. Utiliza una lista de campos separados por comas para especificar múltiples campos.

Si alguno de los nombres de tus campos incluye espacios en blanco, utilice comillas para encerrar la lista de campos. Por ejemplo, si desearas exportar dos campos, phone y user number, especificarías --fields "phone,user number".

Para los formatos de salida csv, mongoexport incluye solo los campos especificados, y los campos especificados pueden ser un campo dentro de un subdocumento.

Para los formatos de salida JSON, mongoexport incluye solo los campos especificados y el campo _id, y si los campos especificados son un campo dentro de un subdocumento, mongoexport incluye el subdocumento con todos los campos, no solo el campo especificado dentro del documento.

Consulta: Exportar datos en formato CSV usando la opción --fields para ver una muestra de uso.

--fieldFile=<filename>

Una alternativa a --fields. La opción --fieldFile permite especificar en un archivo el o los campos que se deseen incluir en la exportación y solo es válida con la opción --type con el valor csv. El archivo debe tener solo un campo por línea, y las líneas deben terminar con el carácter LF (0x0A).

mongoexport incluye solo los campos especificados. Los campos especificados pueden ser un campo dentro de un subdocumento.

Consulta Usar un archivo para especificar los campos para exportar en formato CSV para ver una muestra de uso.

--query=<JSON>, -q=<JSON>

Ofrece una query como un documento JSON (entre comillas) para devolver documentos coincidentes en la exportación.

Se debe encerrar el documento de query entre comillas simples ('{ ... }') para garantizar que no haya interacción con el entorno de shell.

La consulta debe estar en formato JSON2 extendido v (modo relajado o canónico/estricto), incluyendo encerrar los nombres de campo y operadores entre comillas:

Por ejemplo, dada una colección llamada records en la base de datos test con los siguientes documentos:

{ "_id" : ObjectId("51f0188846a64a1ed98fde7c"), "a" : 1, "date" : ISODate("1960-05-01T00:00:00Z") }
{ "_id" : ObjectId("520e61b0c6646578e3661b59"), "a" : 1, "b" : 2, "date" : ISODate("1970-05-01T00:00:00Z") }
{ "_id" : ObjectId("520e642bb7fa4ea22d6b1871"), "a" : 2, "b" : 3, "c" : 5, "date" : ISODate("2010-05-01T00:00:00Z") }
{ "_id" : ObjectId("520e6431b7fa4ea22d6b1872"), "a" : 3, "b" : 3, "c" : 6, "date" : ISODate("2015-05-02T00:00:00Z") }
{ "_id" : ObjectId("520e6445b7fa4ea22d6b1873"), "a" : 5, "b" : 6, "c" : 8, "date" : ISODate("2018-03-01T00:00:00Z") }
{ "_id" : ObjectId("5cd0de910dbce4346295ae28"), "a" : 15, "b" : 5, "date" : ISODate("2015-03-01T00:00:00Z") }

El siguiente mongoexport utiliza la opción -q para exportar solo los documentos con el campo a mayor o igual que ($gte) 3 y el campo date menor que ($lt) ISODate("2016-01-01T00:00:00Z"), lo cual se especifica usando el formato Extended JSON v2 (modo relajado) para fechas ( { "$date": "YYYY-MM-DDTHH:mm:ss.mmm\<offset\>"} ):

mongoexport -d=test -c=records -q='{ "a": { "$gte": 3 }, "date": { "$lt": { "$date": "2016-01-01T00:00:00.000Z" } } }' --out=exportdir/myRecords.json

El archivo resultante contiene los siguientes documentos:

{"_id":{"$oid":"520e6431b7fa4ea22d6b1872"},"a":3.0,"b":3.0,"c":6.0,"date":{"$date":"2015-05-02T00:00:00Z"}}
{"_id":{"$oid":"5cd0de910dbce4346295ae28"},"a":15.0,"b":5.0,"date":{"$date":"2015-03-01T00:00:00Z"}}

Usted puede ordenar los resultados con la opción --sort para mongoexport.

--queryFile=<filename>

Una alternativa a --query. La opción --queryFile permite especificar en un archivo la query en formato Extended JSON v2.

--type=<string>

Default: json

Especifica el tipo de archivo a exportar. Especificar csv para el formato CSV o json para el formato JSON.

Si especifica csv, entonces también debe usar la opción --fields o la opción --fieldFile para declarar los campos que se exportarán de la colección.

--out=<file>, -o=<file>

Especifica un archivo en el que guardar la exportación. Si no se especifica un nombre de archivo, mongoexport escribe datos en la salida estándar (por ejemplo, stdout).

--jsonFormat=<canonical|relaxed>

Por defecto: relajado

Modifica la salida para usar el modo canónico o el modo relajado del formato MongoDB Extended JSON (v2).

Para conocer las diferencias entre los modos canónico y relajado, consulta MongoDB Extended JSON (v2).

--jsonArray

Modifica la salida de mongoexport para guardar todo el contenido de la exportación como un único arreglo JSON. Por defecto, mongoexport guarda datos usando un documento JSON por cada documento de MongoDB.

--pretty

Genera documentos en un formato JSON con impresión legible.

--noHeaderLine

Por defecto, mongoexport incluye los nombres de los campos exportados como la primera línea en una salida CSV. --noHeaderLine indica a mongoexport que exporte los datos sin la lista de nombres de campos. --noHeaderLine solo es válida con la opción --type con el valor csv.

Consulta Excluir nombres de campo de la salida CSV para ver una muestra de uso.

--readPreference=<string|document>

Por defecto: primary

Especifica la preferencia de lectura para mongoexport. La opción --readPreference puede tomar:

• Un string si solo se especifica el modo de preferencia de lectura:

  --readPreference=secondary

• Un documento entre comillas para especificar la moda, los conjuntos de etiquetas de preferencia de lectura opcionales, y el maxStalenessSeconds: opcional.

  --readPreference='{mode: "secondary", tagSets: [ { "region": "east" } ], maxStalenessSeconds: 120}'

  Si se especifica el maxStalenessSeconds, el valor debe ser mayor o igual a 90.

mongoexport tiene por defecto preferencia de lectura primary.

Si la preferencia de lectura también se incluye en la --uri connection string, la línea de comandos --readPreference anula la preferencia de lectura especificada en la string URI.

--skip=<number>

Utilice --skip para controlar dónde mongoexport comienza a exportar documentos. Consulte skip() para obtener información sobre la operación subyacente.

--limit=<number>

Especifica un número máximo de documentos para incluir en la exportación. Consulte limit() para obtener información sobre la operación subyacente.

--sort=<JSON>

Especifica un orden para los resultados exportados. Si no existe un índice que pueda dar soporte a la operación de ordenación, los resultados deben ser inferiores a 32 megabytes.

Se debe usar --sort en conjunto con --skip y --limit para limitar la cantidad de documentos exportados.

mongoexport -d=test -c=records --sort='{a: 1}' --limit=100 --out=export.0.json
mongoexport -d=test -c=records --sort='{a: 1}' --limit=100 --skip=100 --out=export.1.json
mongoexport -d=test -c=records --sort='{a: 1}' --limit=100 --skip=200 --out=export.2.json

Consulta sort() para obtener información sobre la operación subyacente.

Obtén más información

• Compatibilidad e instalación de mongoexport

• Comportamiento de mongoexport

• Ejemplos de mongoexport