- Reference >
- MongoDB Package Components >
mongodump
mongodump
¶
On this page
Mac OSX Sierra and Go 1.6 Incompatibility
Users running on Mac OSX Sierra require the 3.2.10 or newer version of mongodump.
Synopsis¶
mongodump
is a utility for creating a binary export of the
contents of a database. mongodump
can export data from
either mongod
or mongos
instances.
mongodump
can be a part of a backup strategy with mongorestore
for partial
backups based on a query, syncing from production to staging or
development environments, or changing the storage engine of a
standalone. However, the use of mongodump
and
mongorestore
as a backup strategy can be problematic for
sharded clusters and replica sets.
For an overview of mongodump
in conjunction with
mongorestore
part of a backup and recovery strategy, see
Back Up and Restore with MongoDB Tools.
Behavior¶
Data Exclusion¶
mongodump
excludes the content of the local
database in its output.
mongodump
only captures the documents in the database in its
backup data and does not include index data. mongorestore
or
mongod
must then rebuild the indexes after restoring data.
Version Compatibility¶
The data format used by mongodump
from version 2.2 or
later is incompatible with earlier versions of mongod
.
Do not use recent versions of mongodump
to back up older
data stores.
Read Preference¶
Overwrite Files¶
mongodump
overwrites output files if they exist in the
backup data folder. Before running the mongodump
command
multiple times, either ensure that you no longer need the files in the
output folder (the default is the dump/
folder) or rename the
folders or files.
Data Compression Handling¶
When run against a mongod
instance that uses the
WiredTiger storage engine,
mongodump
outputs uncompressed data.
Required Access¶
To run mongodump
against a MongoDB deployment that has
access control enabled, you must have
privileges that grant find
action for each database to
back up. The built-in backup
role provides the required
privileges to perform backup of any and all databases.
Changed in version 3.0.9: The backup
role provides additional privileges to back
up the system.profile
collections that exist when running with database profiling. Previously, users required an additional
read
access on this collection.
Options¶
Changed in version 3.0.0: mongodump
removed the --dbpath
as well as related
--directoryperdb
and --journal
options. To use
mongodump
, you must run mongodump
against a running
mongod
or mongos
instance as appropriate.
-
mongodump
¶
-
--help
¶
Returns information on the options and use of mongodump.
-
--verbose
,
-v
¶
Increases the amount of internal reporting returned on standard output or in log files. Increase the verbosity with the
-v
form by including the option multiple times, (e.g.-vvvvv
.)
-
--quiet
¶
Runs the mongodump 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 mongodump release number.
-
--host
<hostname><:port>
,
-h
<hostname><:port>
¶ Default: localhost:27017
Specifies a resolvable hostname for the
mongod
to which to connect. By default, the mongodump attempts to connect to a MongoDB instance running on the localhost on port number27017
.To connect to a replica set, specify the
replSetName
and a seed list of set members, as in the following:You can always connect directly to a single MongoDB instance by specifying the host and port number directly.
Changed in version 3.0.0: 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
¶
Enables IPv6 support and allows the mongodump to connect to the MongoDB instance using an IPv6 network. All MongoDB programs and processes disable IPv6 support by default.
-
--ssl
¶
New in version 2.6.
Enables connection to a
mongod
ormongos
that has TLS/SSL support enabled.Changed in version 3.0: Most MongoDB distributions now include support for TLS/SSL. See Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients for more information about TLS/SSL and MongoDB.
-
--sslCAFile
<filename>
¶ New in version 2.6.
Specifies the
.pem
file that contains the root certificate chain from the Certificate Authority. Specify the file name of the.pem
file using relative or absolute paths.Changed in version 3.0: Most MongoDB distributions now include support for TLS/SSL. See Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients for more information about TLS/SSL and MongoDB.
Warning
For SSL connections (
--ssl
) tomongod
andmongos
, if the mongodump runs without the--sslCAFile
, mongodump will not attempt to validate the server certificates. This creates a vulnerability to expiredmongod
andmongos
certificates as well as to foreign processes posing as validmongod
ormongos
instances. Ensure that you always specify the CA file to validate the server certificates in cases where intrusion is a possibility.
-
--sslPEMKeyFile
<filename>
¶ New in version 2.6.
Specifies the
.pem
file that contains both the TLS/SSL certificate and key. Specify the file name of the.pem
file using relative or absolute paths.This option is required when using the
--ssl
option to connect to amongod
ormongos
that hasCAFile
enabled withoutallowConnectionsWithoutCertificates
.Changed in version 3.0: Most MongoDB distributions now include support for TLS/SSL. See Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients for more information about TLS/SSL and MongoDB.
-
--sslPEMKeyPassword
<value>
¶ New in version 2.6.
Specifies the password to de-crypt the certificate-key file (i.e.
--sslPEMKeyFile
). Use the--sslPEMKeyPassword
option only if the certificate-key file is encrypted. In all cases, the mongodump 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
--sslPEMKeyPassword
option, the mongodump will prompt for a passphrase. See SSL Certificate Passphrase.Changed in version 3.0: Most MongoDB distributions now include support for TLS/SSL. See Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients for more information about TLS/SSL and MongoDB.
-
--sslCRLFile
<filename>
¶ New in version 2.6.
Specifies the
.pem
file that contains the Certificate Revocation List. Specify the file name of the.pem
file using relative or absolute paths.Changed in version 3.0: Most MongoDB distributions now include support for TLS/SSL. See Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients for more information about TLS/SSL and MongoDB.
-
--sslAllowInvalidCertificates
¶
New in version 2.6.
Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the
allowInvalidCertificates
setting, MongoDB logs as a warning the use of the invalid certificate.Changed in version 3.0: Most MongoDB distributions now include support for TLS/SSL. See Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients for more information about TLS/SSL and MongoDB.
-
--sslAllowInvalidHostnames
¶
New in version 3.0.
Disables the validation of the hostnames in TLS/SSL certificates. Allows mongodump to connect to MongoDB instances even if the hostname in their certificates do not match the specified hostname.
Changed in version 3.0: Most MongoDB distributions now include support for TLS/SSL. See Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients for more information about TLS/SSL and MongoDB.
-
--sslFIPSMode
¶
New in version 2.6.
Directs the mongodump to use the FIPS mode of the installed OpenSSL library. Your system must have a FIPS compliant OpenSSL library to use the
--sslFIPSMode
option.Note
FIPS-compatible SSL is available only in MongoDB Enterprise. See Configure MongoDB for FIPS for more information.
-
--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.
-
--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.Changed in version 3.0.0: If you do not specify an argument for
--password
, mongodump returns an error.Changed in version 3.0.2: If you wish mongodump to prompt the user for the password, pass the
--username
option without--password
or specify an empty string as the--password
value, as in--password ""
.
-
--authenticationDatabase
<dbname>
¶ If you do not specify an authentication database, mongodump assumes that the database specified to export holds the user’s credentials.
-
--authenticationMechanism
<name>
¶ Default: SCRAM-SHA-1
New in version 2.4.
Changed in version 2.6: Added support for the
PLAIN
andMONGODB-X509
authentication mechanisms.Changed in version 3.0: Added support for the
SCRAM-SHA-1
authentication mechanism. Changed default mechanism toSCRAM-SHA-1
.Specifies the authentication mechanism the mongodump instance uses to authenticate to the
mongod
ormongos
.Value Description SCRAM-SHA-1 RFC 5802 standard Salted Challenge Response Authentication Mechanism using the SHA1 hash function. MONGODB-CR MongoDB challenge/response authentication. 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 PLAIN
for authenticating in-database users.PLAIN
transmits passwords in plain text. This mechanism is available only in MongoDB Enterprise.
-
--gssapiServiceName
¶
New in version 2.6.
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
¶
New in version 2.6.
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 a database to backup. If you do not specify a database,
mongodump
copies all databases in this instance into the dump files.
-
--collection
<collection>
,
-c
<collection>
¶ Specifies a collection to backup. If you do not specify a collection, this option copies all collections in the specified database or instance to the dump files.
-
--query
<json>
,
-q
<json>
¶ Provides a JSON document as a query that optionally limits the documents included in the output of
mongodump
.You must enclose the query in single quotes (e.g.
'
) to ensure that it does not interact with your shell environment.
-
--forceTableScan
¶
Forces
mongodump
to scan the data store directly: typically,mongodump
saves entries as they appear in the index of the_id
field. If you specify a query--query
, mongodump will use the most appropriate index to support that query.Use
--forceTableScan
to skip the index and scan the data directly. 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
_id
index. - Your database uses a custom
_id
field.
When you run with
--forceTableScan
,mongodump
does not use$snapshot
. As a result, the dump produced bymongodump
can reflect the state of the database at many different points in time.Important
Use
--forceTableScan
with extreme caution and consideration.- If you have key sizes over 800 bytes that would not be present in the
-
--out
<path>
,
-o
<path>
¶ Specifies the directory where
mongodump
will write BSON files for the dumped databases. By default,mongodump
saves output files in a directory nameddump
in the current working directory.To send the database dump to standard output, specify “
-
” instead of a path. Write to standard output if you want process the output before saving it, such as to usegzip
to compress the dump. When writing standard output,mongodump
does not write the metadata that writes in a<dbname>.metadata.json
file when writing to files directly.
-
--repair
¶
Runs a repair option in addition to dumping the database. The repair option changes the behavior of mongodump to only write valid data and exclude data that may be in an invalid state as a result of an improper shutdown or
mongod
crash.The
--repair
option uses aggressive data-recovery algorithms that may produce a large amount of duplication.--repair
is only available for use withmongod
instances using themmapv1
storage engine. You cannot run--repair
withmongos
or withmongod
instances that use thewiredTiger
storage engine. To repair data in amongod
instance usingwiredTiger
usemongod --repair
.
-
--oplog
¶
Creates a file named
oplog.bson
as part of themongodump
output. Theoplog.bson
file, located in the top level of the output directory, contains oplog entries that occur during themongodump
operation. This file provides an effective point-in-time snapshot of the state of amongod
instance. To restore to a specific point-in-time backup, use the output created with this option in conjunction withmongorestore --oplogReplay
.Without
--oplog
, if there are write operations during the dump operation, the dump will not reflect a single moment in time. Changes made to the database during the update process can affect the output of the backup.--oplog
has no effect when runningmongodump
against amongos
instance to dump the entire contents of a sharded cluster. However, you can use--oplog
to dump individual shards.--oplog
only works against nodes that maintain an oplog. This includes all members of a replica set, as well as master nodes in master/slave replication deployments.--oplog
does not dump the oplog collection.
-
--dumpDbUsersAndRoles
¶
Includes user and role definitions in the database’s dump directory when performing
mongodump
on a specific database. This option applies only when you specify a database in the--db
option. MongoDB always includes user and role definitions whenmongodump
applies to an entire instance and not just a specific database.
-
--excludeCollection
string
¶ New in version 3.0.0.
Excludes the specified collection from the mongodump output. To exclude multiple collections, specify the
--excludeCollection
multiple times.
-
--excludeCollectionsWithPrefix
string
¶ New in version 3.0.0.
Excludes all collections with a specified prefix from the mongodump outputs. To specify multiple prefixes, specify the
--excludeCollectionsWithPrefix
multiple times.
Use¶
For an overview of mongodump
usage, see
Back Up and Restore with MongoDB Tools
For an overview of mongorestore
, which provides the related inverse
functionality, see the mongorestore document.
The following operation creates a dump file that contains only the
collection named collection
in the database named test
. In
this case the database is running on the local interface on port
27017
:
mongodump
a Database Excluding Specified Collections¶
The following operation dumps all collections in the test
database
except for users
and salaries
: