- Reference >
- MongoDB Package Components >
mongorestore
mongorestore
¶
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 mongorestore.
Synopsis¶
The mongorestore
program writes data from a binary database
dump created by mongodump
to a MongoDB instance.
New in version 3.0.0: mongorestore
also accepts data to
restore via the standard input.
mongorestore
can write data to either mongod
or
mongos
instances.
Behavior¶
Insert Only¶
mongorestore
can create a new database or add data to an
existing database. However, mongorestore
performs inserts
only and does not perform updates. That is, if restoring documents to
an existing database and collection and existing documents have the
same value _id
field as the to-be-restored documents,
mongorestore
will not overwrite those documents.
Rebuild Indexes¶
mongorestore
recreates indexes recorded by
mongodump
.
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.
Exclude system.profile
Collection¶
mongorestore
does not restore the system.profile
collection data; however, if the backup
data includes system.profile
collection data and the collection does not exist in the target
database, mongorestore
creates the collection but does not
insert any data into the collection.
Required Access¶
To restore data to a MongoDB deployment that has access control enabled, the restore
role provides
access to restore any database if the backup data does not include
system.profile
collection data.
If the backup data includes system.profile
collection data and the target database
does not contain the system.profile
collection, mongorestore
attempts to create the collection
even though the program does not actually restore system.profile
documents. As such, the user requires additional privileges to perform
createCollection
and convertToCapped
actions on the system.profile
collection for a database.
If running mongorestore
with --oplogReplay
,
create a user-defined role that
has anyAction
on anyResource and grant
only to users who must run mongorestore
with
--oplogReplay
.
Options¶
Changed in version 3.0.0: mongorestore
removed the --filter
, --dbpath
, and the
--noobjcheck
options.
-
mongorestore
¶
-
--help
¶
Returns information on the options and use of mongorestore.
-
--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 mongorestore 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 mongorestore 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 mongorestore 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 mongorestore 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 mongorestore runs without the--sslCAFile
, mongorestore 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 mongorestore 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 mongorestore 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 mongorestore 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 mongorestore 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
, mongorestore returns an error.Changed in version 3.0.2: If you wish mongorestore 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>
¶ New in version 2.4.
Specifies the database in which the user is created. See Authentication Database.
-
--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 mongorestore 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 for mongorestore to restore data into. If the database does not exist, mongorestore creates the database. If you do not specify a
<db>
, mongorestore creates new databases that correspond to the databases where data originated and data may be overwritten. Use this option to restore data into a MongoDB instance that already has data.--db
does not control which BSON files mongorestore restores. You must use the mongorestore path option to limit that restored data.
-
--collection
<collection>
,
-c
<collection>
¶ Specifies a single collection for mongorestore to restore. If you do not specify
--collection
, mongorestore takes the collection name from the input filename. If the input file has an extension, MongoDB omits the extension of the file from the collection name.
-
--objcheck
¶
Forces mongorestore to validate all requests from clients upon receipt to ensure that clients never insert invalid documents into the database. For objects with a high degree of sub-document nesting,
--objcheck
can have a small impact on performance.Changed in version 2.4: MongoDB enables
--objcheck
by default, to prevent any client from inserting malformed or invalid BSON into a MongoDB database.
-
--drop
¶
Before restoring the collections from the dumped backup, drops the collections from the target database.
--drop
does not drop collections that are not in the backup.When the restore includes the
admin
database, mongorestore with--drop
removes all user credentials and replaces them with the users defined in the dump file. Therefore, in systems withauthorization
enabled, mongorestore must be able to authenticate to an existing user and to a user defined in the dump file. If mongorestore can’t authenticate to a user defined in the dump file, the restoration process will fail, leaving an empty database.
-
--oplogReplay
¶
After restoring the database dump, replays the oplog entries from the
oplog.bson
file located in the top level of the dump directory. When used in conjunction withmongodump --oplog
,~bin.mongorestore --oplogReplay
restores the database to the point-in-time backup captured with themongodump --oplog
command. For an example of--oplogReplay
, see Restore Point in Time Oplog Backup.~bin.mongorestore --oplogReplay
replays any validoplog.bson
file found in the top level of the dump directory. That is, if you have a bson file that contains valid oplog entries, you can name the fileoplog.bson
and move it to the top level of the dump directory for~bin.mongorestore --oplogReplay
to replay.See also
-
--oplogLimit
<timestamp>
¶ Prevents mongorestore from applying oplog entries with timestamp newer than or equal to
<timestamp>
. Specify<timestamp>
values in the form of<time_t>:<ordinal>
, where<time_t>
is the seconds since the UNIX epoch, and<ordinal>
represents a counter of operations in the oplog that occurred in the specified second.You must use
--oplogLimit
in conjunction with the--oplogReplay
option.
-
--keepIndexVersion
¶
Prevents mongorestore from upgrading the index to the latest version during the restoration process.
-
--noIndexRestore
¶
Prevents mongorestore from restoring and building indexes as specified in the corresponding
mongodump
output.
-
--noOptionsRestore
¶
Prevents mongorestore from setting the collection options, such as those specified by the
collMod
database command, on restored collections.
-
--restoreDbUsersAndRoles
¶
Restore user and role definitions for the given database. See system.roles Collection and system.users Collection for more information.
-
--writeConcern
<document>
¶ Default: majority
Specifies the write concern for each write operation that mongorestore writes to the target database.
Specify the write concern as a document with w options.
-
--maintainInsertionOrder
¶
Default: false
If specified, mongorestore inserts the documents in the order of their appearance in the input source, otherwise mongorestore may perform the insertions in an arbitrary order.
-
--numParallelCollections
int
,
-j
int
¶ Default: 4
Number of collections mongorestore should restore in parallel.
If you specify
-j
when restoring a single collection,-j
maps to the--numInsertionWorkersPerCollection
option rather than--numParallelCollections
.
-
--numInsertionWorkersPerCollection
int
¶ Default: 1
New in version 3.0.0.
Specifies the number of insertion workers to run concurrently per collection.
For large imports, increasing the number of insertion workers may increase the speed of the import.
-
--stopOnError
¶
New in version 3.0.0.
Forces mongorestore to halt the restore when it encounters an error.
-
<path>
¶
The final argument of the mongorestore command is a directory path. This argument specifies the location of the database dump from which to restore.
You cannot specify both the
<path>
argument and the--dir
option, which also specifies the dump directory, to mongorestore.
-
--dir
string
¶ Specifies the dump directory.
You cannot specify both the
--dir
option and the<path>
argument, which also specifies the dump directory, to mongorestore.
Use¶
For an overview of mongorestore
usage, see
Back Up and Restore with MongoDB Tools.
For an overview of mongodump
, which provides the related
inverse functionality, see the mongodump document.
Consider the following example:
Here, mongorestore
reads the database dump in the dump/
sub-directory of the current directory, and restores only the
documents in the collection named people
from the database named
accounts
. mongorestore
restores data to the instance
running on the localhost interface on port 27017
.
In the following example, mongorestore
restores a database
dump located at /opt/backup/mongodump-2011-10-24
, to a database
running on port 37017
on the host
mongodb1.example.net
. The mongorestore
command authenticates to
the MongoDB instance using the username user
and the
password pass
, as follows:
You can also pipe data directly into to mongorestore
through standard input, as in the following example: