- Reference >
- MongoDB Package Components >
mongoexport
mongoexport¶
On this page
macOS Sierra and Go 1.6 Incompatibility
Users running on macOS Sierra require the 3.2.10 or newer version
of mongoexport.
Upcoming Tools Migration in MongoDB 4.4
Starting in MongoDB 4.4, the mongoexport documentation
migrates to MongoDB Database Tools - mongoexport. Refer to
that page for more information on the upcoming version of
mongoexport (tool version 100.0.0).
The documentation on this page only applies to the MongoDB 4.2
version of mongoexport. The MongoDB 4.2 version of
mongoexport is available for download following the instructions
in the Availability section below.
Synopsis¶
mongoexport is a command-line tool that produces a JSON
or CSV export of data stored in a MongoDB instance.
Run mongoexport from the system command line, not the mongo shell.
See also
mongoimport which provides the corresponding “import”
capability.
Note
If you are archiving stale data to save on storage costs, consider Online Archive in MongoDB Atlas. Online Archive automatically archives infrequently accessed data to fully-managed S3 buckets for cost-effective data tiering.
Availability¶
The mongoexport tool is part of the MongoDB tools package. Consult the
installation guide for your platform for
instructions on how to install the tools package as part of your
MongoDB installation.
The tools package is also available from the
MongoDB Download Center,
either as a separate tools download, or contained within the
TGZ or ZIP downloads, depending on platform. On Windows, the MSI installer includes all tools as part of the default installation.
Tip
If downloading the TGZ or ZIP files from the Download
Center, you may want to update your PATH environment
variable to include the directory where you installed these tools.
See the installation guide
for your platform for more information.
Syntax¶
mongoexport must be run directly from the system command line.
You must specify the collection to
export. If you do not specify an output file, mongoexport writes to the standard output (e.g.
stdout).
Connect to a MongoDB Instance¶
To connect to a local MongoDB instance running on port 27017, you do not have to specify the host or port.
For example, to export the specified collection to the specified output file from a local MongoDB instance running on port 27017:
To specify a host and/or port of the MongoDB instance, you can either:
Specify the hostname and port in the
--uri connection string:If using the
--uri connection string, specify the database as part of the string. You cannot use the command-line option--dbin conjunction with the--uri connection string.Specify the hostname and port in the
--host:
For more information on the options available, see Options.
Connect to a Replica Set¶
To connect to a replica set to export its data, you can either:
Specify the replica set name and members in the
--uri connection string:If using the
--uri connection string, specify the database as part of the string. You cannot use the command-line option--dbin conjunction with the--uri connection string.Specify the replica set name and members in the
--host:
By default, mongoexport reads from the primary of the
replica set. To override the default, you can specify the read
preference:
You can specify the read preference in the
--uri connection stringIf specifying the read preference tags, include the
readPreferenceTagsoption:If using the
--uri connection string, specify the database as part of the string. You cannot use the command-line option--dbin conjunction with the--uri connection string.You can specify the read preference in using the
--readPreferencecommand-line option. The command-line option takes a string if specifying only the read preference mode:Or, the command-line option can takes a quote-enclosed document
'{ mode: <mode>, tagSets: [ <tag1>, ... ], maxStalenessSeconds:<num>}'to specify the mode, the optional read preference tag sets, and the optional maxStalenessSeconds:
For more information on the options available, see Options.
Connect to a Sharded Cluster¶
To connect to a sharded cluster to export its data, you can either:
Specify the hostname of the
mongosinstance in the--uri connection stringIf using the
--uri connection string, specify the database as part of the string. You cannot use the command-line option--dbin conjunction with the--uri connection string.Specify the hostname and port of the
mongosinstance in the--host
By default, mongoexport reads from the primary of the
shard replica set. To override the default, you can specify the read
preference:
You can specify the read preference in the
--uri connection stringIf specifying the read preference tags, include the
readPreferenceTagsoption:If using the
--uri connection string, specify the database as part of the string. You cannot use the command-line option--dbin conjunction with the--uri connection string.You can specify the read preference in using the
--readPreferencecommand-line option. The command-line option takes a string if specifying only the read preference mode:Or, the command-line option can takes a quote-enclosed document
'{ mode: <mode>, tagSets: [ <tag1>, ... ], maxStalenessSeconds:<num>}'to specify the mode, the optional read preference tag sets, and the optional maxStalenessSeconds:
For more information on the options available, see Options.
See also
Required Access¶
mongoexport requires read access on the target database.
Ensure that the connecting user possesses, at a minimum, the read
role on the target database.
When connecting to a mongod or mongos that enforces
Authentication, ensure you use the required security
parameters based on the configured
authentication mechanism.
Behavior¶
Type Fidelity¶
Warning
Avoid using mongoimport and mongoexport for
full instance production backups. They do not reliably preserve all rich
BSON data types, because JSON can only represent a subset
of the types supported by BSON. Use mongodump
and mongorestore as described in MongoDB Backup Methods for this
kind of functionality.
Starting in version 4.2, mongoexport:
- Outputs data in Extended JSON v2.0 (Relaxed mode) by default.
- Outputs Extended JSON v2.0 (Canonical mode) if used with
--jsonFormat.
Earlier versions used Extended JSON v1.0 (Canonical mode).
For example, the following insert operation in the mongo
shell uses the various shell helpers for the
BSON types Date and 64-bit integer:
The argument to 64-bit integer must be quoted to avoid potential loss of accuracy.
Use mongoexport to export the data:
In version 4.2+, the exported data is in Extended JSON v2.0 (Relaxed mode).
To output in Extended JSON v2.0 (Canonical
mode), include the
--jsonFormat=canonical:
The exported data is in Extended JSON v2.0 (Canonical mode):
In version 4.0 and earlier, the exported data is in Extended JSON v1.0 (Strict mode)
FIPS¶
Starting in version 4.2, MongoDB removes the --sslFIPSMode
option for mongoexport. mongoexport
will use FIPS compliant connections to
mongod/mongos if the
mongod/mongos instances are
configured to use FIPS mode.
Read Preference¶
By default, mongoexport uses read preference
primary. To override the default, you can specify the
read preference in the
--readPreference command line
option or in the --uri connection string.
Starting in version 4.2, if you specify read preference in the URI
string and the --readPreference, the --readPreference value overrides the read preference specified in the
URI string.
In earlier versions, the two options are incompatible.
Options¶
-
mongoexport¶
-
--help¶ Returns information on the options and use of mongoexport.
-
--verbose,-v¶ Increases the amount of internal reporting returned on standard output or in log files. Increase the verbosity with the
-vform by including the option multiple times, (e.g.-vvvvv.)
-
--quiet¶ Runs mongoexport in a quiet mode that attempts to limit the amount of output.
This option suppresses:
- output from database commands
- replication activity
- connection accepted events
- connection closed events
-
--version¶ Returns the mongoexport release number.
-
--uri=<connectionString>¶ New in version 3.4.6.
Specify a resolvable URI connection string (enclose in quotes) to connect to the MongoDB deployment.
For information on the components of the connection string, see the Connection String URI Format documentation.
Note
For TLS/SSL options, use the command-line options instead of the URI options for TLS/SSL (Available starting in 4.2).
Important
The following command-line options cannot be used in conjunction with
--urioption:--host--port--db--username--password(if the URI connection string also includes the password)--authenticationDatabase--authenticationMechanism
Instead, specify these options as part of your
--uriconnection string.
-
--host=<hostname><:port>,-h=<hostname><:port>¶ Default: localhost:27017
Specifies a resolvable hostname for the
mongodto which to connect. By default, the mongoexport attempts to connect to a MongoDB instance running on the localhost on port number27017.To connect to a replica set, specify the
replSetNameand a seed list of set members, as in the following:When specifying the replica set list format, mongoexport always connects to the primary.
You can also connect to any single member of the replica set by specifying the host and port of only that member:
If you use IPv6 and use the
<address>:<port>format, you must enclose the portion of an address and port combination in brackets (e.g.[<address>]).
-
--port=<port>¶ Default: 27017
Specifies the TCP port on which the MongoDB instance listens for client connections.
-
--ipv6¶ Removed in version 3.0.
Enables IPv6 support and allows mongoexport to connect to the MongoDB instance using an IPv6 network. Prior to MongoDB 3.0, you had to specify
--ipv6to use IPv6. In MongoDB 3.0 and later, IPv6 is always enabled.
-
--ssl¶ Enables connection to a
mongodormongosthat has TLS/SSL support enabled.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
--sslCAFile=<filename>¶ Specifies the
.pemfile that contains the root certificate chain from the Certificate Authority. Specify the file name of the.pemfile using relative or absolute paths.Starting in version 3.4, if
--tlsCAFile/net.tls.CAFile(or their aliases--sslCAFile/net.ssl.CAFile) is not specified and you are not using x.509 authentication, the system-wide CA certificate store will be used when connecting to an TLS/SSL-enabled server.To use x.509 authentication,
--tlsCAFileornet.tls.CAFilemust be specified unless using--tlsCertificateSelectoror--net.tls.certificateSelector. Or if using thesslaliases,--sslCAFileornet.ssl.CAFilemust be specified unless using--sslCertificateSelectorornet.ssl.certificateSelector.Warning
Version 3.2 and earlier: For TLS/SSL connections (
--ssl) tomongodandmongos, if the mongoexport runs without the--sslCAFile, mongoexport will not attempt to validate the server certificates. This creates a vulnerability to expiredmongodandmongoscertificates as well as to foreign processes posing as validmongodormongosinstances. Ensure that you always specify the CA file to validate the server certificates in cases where intrusion is a possibility.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
--sslPEMKeyFile=<filename>¶ Specifies the
.pemfile that contains both the TLS/SSL certificate and key. Specify the file name of the.pemfile using relative or absolute paths.This option is required when using the
--ssloption to connect to amongodormongosthat hasCAFileenabled withoutallowConnectionsWithoutCertificates.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
--sslPEMKeyPassword=<value>¶ Specifies the password to de-crypt the certificate-key file (i.e.
--sslPEMKeyFile). Use the--sslPEMKeyPasswordoption only if the certificate-key file is encrypted. In all cases, the mongoexport will redact the password from all logging and reporting output.If the private key in the PEM file is encrypted and you do not specify the
--sslPEMKeyPasswordoption, the mongoexport will prompt for a passphrase. See TLS/SSL Certificate Passphrase.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
--sslCRLFile=<filename>¶ Specifies the
.pemfile that contains the Certificate Revocation List. Specify the file name of the.pemfile using relative or absolute paths.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
--sslAllowInvalidCertificates¶ Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the
allowInvalidCertificatessetting, MongoDB logs as a warning the use of the invalid certificate.Starting in MongoDB 4.0, if you specify
--sslAllowInvalidCertificatesornet.ssl.allowInvalidCertificates: true(or in MongoDB 4.2, the alias--tlsAllowInvalidateCertificatesornet.tls.allowInvalidCertificates: true) when using x.509 authentication, an invalid certificate is only sufficient to establish a TLS/SSL connection but is insufficient for authentication.Warning
Although available, avoid using the
--sslAllowInvalidCertificatesoption if possible. If the use of--sslAllowInvalidCertificatesis necessary, only use the option on systems where intrusion is not possible.If the
mongoshell (and other MongoDB Tools) runs with the--sslAllowInvalidCertificatesoption, themongoshell (and other MongoDB Tools) will not attempt to validate the server certificates. This creates a vulnerability to expiredmongodandmongoscertificates as well as to foreign processes posing as validmongodormongosinstances. If you only need to disable the validation of the hostname in the TLS/SSL certificates, see--sslAllowInvalidHostnames.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
--sslAllowInvalidHostnames¶ Disables the validation of the hostnames in TLS/SSL certificates. Allows mongoexport to connect to MongoDB instances even if the hostname in their certificates do not match the specified hostname.
For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .
-
--username=<username>,-u=<username>¶ Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the
--passwordand--authenticationDatabaseoptions.Note
You cannot specify both
--usernameand--uri.
-
--password=<password>,-p=<password>¶ Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the
--usernameand--authenticationDatabaseoptions.To prompt the user for the password, pass the
--usernameoption without--passwordor specify an empty string as the--passwordvalue, as in--password "".Note
You cannot specify both
--passwordand--uri.
-
--authenticationDatabase=<dbname>¶ Specifies the authentication database where the specified
--usernamehas been created. See Authentication Database.Note
You cannot specify both
--authenticationDatabaseand--uri.If you do not specify an authentication database, mongoexport assumes that the database specified to export holds the user’s credentials.
-
--authenticationMechanism=<name>¶ Default: SCRAM-SHA-1
Specifies the authentication mechanism the mongoexport instance uses to authenticate to the
mongodormongos.Changed in version 4.0: MongoDB removes support for the deprecated MongoDB Challenge-Response (
MONGODB-CR) authentication mechanism.MongoDB adds support for SCRAM mechanism using the SHA-256 hash function (
SCRAM-SHA-256).Value Description 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.
Requires featureCompatibilityVersion set to
4.0.New in version 4.0.
MONGODB-X509 MongoDB TLS/SSL certificate authentication. GSSAPI (Kerberos) External authentication using Kerberos. This mechanism is available only in MongoDB Enterprise. PLAIN (LDAP SASL) External authentication using LDAP. You can also use PLAINfor authenticating in-database users.PLAINtransmits passwords in plain text. This mechanism is available only in MongoDB Enterprise.Note
You cannot specify both
--authenticationMechanismand--uri.
-
--gssapiServiceName=<serviceName>¶ Specify the name of the service using GSSAPI/Kerberos. Only required if the service does not use the default name of
mongodb.This option is available only in MongoDB Enterprise.
-
--gssapiHostName=<hostname>¶ Specify the hostname of a service using GSSAPI/Kerberos. Only required if the hostname of a machine does not match the hostname resolved by DNS.
This option is available only in MongoDB Enterprise.
-
--db=<database>,-d=<database>¶ Specifies the name of the database on which to run the mongoexport.
-
--collection=<collection>,-c=<collection>¶ Specifies the collection to export.
-
--fields=<field1[,field2]>,-f=<field1[,field2]>¶ Specifies a field or fields to include in the export. Use a comma separated list of fields to specify multiple fields.
If any of your field names include white space, use quotation marks to enclose the field list. For example, if you wished to export two fields,
phoneanduser number, you would specify--fields "phone,user number".For
csvoutput formats,mongoexportincludes only the specified field(s), and the specified field(s) can be a field within a sub-document.For JSON output formats,
mongoexportincludes only the specified field(s) and the_idfield, and if the specified field(s) is a field within a sub-document, themongoexportincludes the sub-document with all its fields, not just the specified field within the document.See: Export Data in CSV Format using --fields option for sample usage.
-
--fieldFile=<filename>¶ An alternative to
--fields. The--fieldFileoption allows you to specify in a file the field or fields to include in the export and is only valid with the--typeoption with valuecsv. The file must have only one field per line, and the line(s) must end with the LF character (0x0A).mongoexportincludes only the specified field(s). The specified field(s) can be a field within a sub-document.See Use a File to Specify the Fields to Export in CSV Format for sample usage.
-
--query=<JSON>,-q=<JSON>¶ Provides a query as a JSON document (enclosed in quotes) to return matching documents in the export.
You must enclose the query document in single quotes (
'{ ... }') to ensure that it does not interact with your shell environment.Starting in MongoDB 4.2, the query must be in Extended JSON v2 format (either relaxed or canonical/strict mode), including enclosing the field names and operators in quotes:
For example, given a collection named
recordsin the databasetestwith the following documents:{ "_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") }
The following
mongoexportuses the-qoption to export only the documents with the fieldagreater than or equal to ($gte) to3and the fielddateless thanISODate("2016-01-01T00:00:00Z")(using the extended JSON v2 format (relaxed mode) for dates { “$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
The resulting file contains the following documents:
{"_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"}}
You can sort the results with the
--sortoption tomongoexport.
-
--type=<string>¶ Default: json
Specifies the file type to export. Specify
csvfor CSV format orjsonfor JSON format.If you specify
csv, then you must also use either the--fieldsor the--fieldFileoption to declare the fields to export from the collection.
-
--out=<file>,-o=<file>¶ Specifies a file to write the export to. If you do not specify a file name, the
mongoexportwrites data to standard output (e.g.stdout).
-
--jsonFormat=<canonical|relaxed>¶ Default: relaxed
Modifies the output to use either canonical or relaxed mode of the MongoDB Extended JSON (v2) format.
For differences between canonical and relaxed modes, see MongoDB Extended JSON (v2).
-
--jsonArray¶ Modifies the output of
mongoexportto write the entire contents of the export as a single JSON array. By defaultmongoexportwrites data using one JSON document for every MongoDB document.
-
--pretty¶ Outputs documents in a pretty-printed format JSON.
-
--noHeaderLine¶ New in version 3.4.
By default, mongoexport includes the exported field names as the first line in a CSV output.
--noHeaderLinedirects mongoexport to export the data without the list of field names.--noHeaderLineis only valid with the--typeoption with valuecsv.See Exclude Field Names from CSV Output for sample usage.
-
--slaveOk,-k¶ Deprecated since version 3.2.
Sets the Read Preference to
nearest, allowingmongoexportto read data from secondary replica set members.--readPreferencereplaces--slaveOkin MongoDB 3.2. You cannot specify--slaveOkwhen--readPreferenceis specified.Warning
Using a read preference other than
primarywith a connection to amongosmay produce inconsistencies, duplicates, or result in missed documents.
-
--readPreference=<string|document>¶ Default:
primarySpecifies the read preference for mongoexport. The
--readPreferenceoption can take:A string if specifying only the read preference mode:
A quote-enclosed document to specify the mode, the optional read preference tag sets, and the optional maxStalenessSeconds:
If specifying the maxStalenessSeconds, the value must be greater than or equal to 90.
New in version 4.2.
mongoexport defaults to
primaryread preference.Starting in version 4.2, if the read preference is also included in the
--uri connection string, the command-line--readPreferenceoverrides the read preference specified in the URI string.Warning
Using a read preference other than
primarywith a connection to amongosmay produce inconsistencies, duplicates, or result in missed documents.
-
--forceTableScan¶ Forces
mongoexportto scan the data store directly instead of traversing the_idfield index. Use--forceTableScanto skip the index. Typically there are two cases where this behavior is preferable to the default:- If you have key sizes over 800 bytes that would not be present
in the
_idindex. - Your database uses a custom
_idfield.
When you run with
--forceTableScan,mongoexportmay return a document more than once if a write operation interleaves with the operation to cause the document to move.Warning
Use
--forceTableScanwith extreme caution and consideration.- If you have key sizes over 800 bytes that would not be present
in the
-
--skip=<number>¶ Use
--skipto control wheremongoexportbegins exporting documents. Seeskip()for information about the underlying operation.
-
--limit=<number>¶ Specifies a maximum number of documents to include in the export. See
limit()for information about the underlying operation.
-
--sort=<JSON>¶ Specifies an ordering for exported results. If an index does not exist that can support the sort operation, the results must be less than 32 megabytes.
Use
--sortconjunction with--skipand--limitto limit number of exported documents.See
sort()for information about the underlying operation.
Examples¶
Export in CSV Format¶
Export Data in CSV Format using --fields option¶
In the following example, mongoexport exports data from the
collection contacts collection in the users database in CSV
format to the file /opt/backups/contacts.csv.
The mongod instance that mongoexport connects to is
running on the localhost port number 27017.
When you export in CSV format, you must specify the fields in the documents
to export. The operation specifies the name and address fields
to export.
The output would then resemble:
Use a File to Specify the Fields to Export in CSV Format¶
For CSV exports only, you can also specify the fields in a file containing the line-separated list of fields to export. The file must have only one field per line.
For example, you can specify the name and address fields in a
file fields.txt:
Then, using the --fieldFile option, specify the fields to export with
the file:
Exclude Field Names from CSV Output¶
New in version 3.4.
MongoDB 3.4 added the --noHeaderLine option for excluding the
field names in a CSV export. The following example exports the name
and address fields in the contacts collection in the users
database and uses --noHeaderLine to suppress the output
of the field names as the first line:
The CSV output would then resemble:
Export in JSON Format¶
This example creates an export of the contacts collection from the
MongoDB instance running on the localhost port number 27017. This
writes the export to the contacts.json file in JSON format.
Export from Remote Host Running with Authentication¶
The following example exports the contacts collection in the
marketing database from a remote MongoDB instance that requires
authentication.
Specify the:
Tip
Omit the --password option to
have mongoexport prompt for the password:
Alternatively, you use the --uri option to specify the host, port, username, authentication database, and db.
Tip
Omit the password in the URI string to have mongoexport prompt
for the password:
Export Query Results¶
You can export only the results of a query by supplying a query filter with
the --query option, and limit the results to a single
database using the “--db” option.
For instance, this command returns all documents in the sales
database’s contacts collection that contain a field named dept
equal to "ABC" and the field date greater than or equal to
ISODate(“2018-01-01”) (using the canonical format for dates
{ “$date”: “YYYY-MM-DDTHH:mm:ss.mmm<offset>”} )
You must enclose the query document in single quotes ('{ ... }') to ensure that it does
not interact with your shell environment.