Usage:
mongorestore <options> <connection-string> <directory or file to restore>
Restore backups generated with mongodump to a running server.
Specify a database with -d to restore a single database from the target directory,
or use -d and -c to restore a single collection from a single .bson file.
Connection strings must begin with mongodb:// or mongodb+srv://.
See http://docs.mongodb.com/database-tools/mongorestore/ for more information.
general options:
--help print usage
--version print the tool
version and exit
--config= path to a
configuration file
verbosity options:
-v, --verbose=<level> more detailed log
output (include
multiple times for
more verbosity,
e.g. -vvvvv, or
specify a numeric
value, e.g.
--verbose=N)
--quiet hide all log output
connection options:
-h, --host=<hostname> mongodb host to
connect to
(setname/host1,host-
2 for replica sets)
--port=<port> server port (can
also use --host
hostname:port)
ssl options:
--ssl connect to a mongod
or mongos that has
ssl enabled
--sslCAFile=<filename> the .pem file
containing the root
certificate chain
from the
certificate
authority
--sslPEMKeyFile=<filename> the .pem file
containing the
certificate and key
--sslPEMKeyPassword=<password> the password to
decrypt the
sslPEMKeyFile, if
necessary
--sslCRLFile=<filename> the .pem file
containing the
certificate
revocation list
--sslFIPSMode use FIPS mode of
the installed
openssl library
--tlsInsecure bypass the
validation for
server's
certificate chain
and host name
authentication options:
-u, --username=<username> username for
authentication
-p, --password=<password> password for
authentication
--authenticationDatabase=<database-name> database that holds
the user's
credentials
--authenticationMechanism=<mechanism> authentication
mechanism to use
--awsSessionToken=<aws-session-token> session token to
authenticate via
AWS IAM
kerberos options:
--gssapiServiceName=<service-name> service name to use
when authenticating
using
GSSAPI/Kerberos
(default: mongodb)
--gssapiHostName=<host-name> hostname to use
when authenticating
using
GSSAPI/Kerberos
(default: <remote
server's address>)
namespace options:
-d, --db=<database-name> database to use
-c, --collection=<collection-name> collection to use
uri options:
--uri=mongodb-uri mongodb uri
connection string
namespace options:
--excludeCollection=<collection-name> DEPRECATED;
collection to skip
over during restore
(may be specified
multiple times to
exclude additional
collections)
--excludeCollectionsWithPrefix=<collection-prefix> DEPRECATED;
collections to skip
over during restore
that have the given
prefix (may be
specified multiple
times to exclude
additional prefixes)
--nsExclude=<namespace-pattern> exclude matching
namespaces
--nsInclude=<namespace-pattern> include matching
namespaces
--nsFrom=<namespace-pattern> rename matching
namespaces, must
have matching nsTo
--nsTo=<namespace-pattern> rename matched
namespaces, must
have matching nsFrom
input options:
--objcheck validate all
objects before
inserting
--oplogReplay for recovering a
point-in-time
snapshot on a
replica set that is
not part of a
sharded cluster.
--oplogLimit=<seconds>[:ordinal] only include oplog
entries before the
provided Timestamp
--oplogFile=<filename> oplog file to use
for replay of oplog
--archive=<filename> restore dump from
the specified
archive file. If
flag is specified
without a value,
archive is read
from stdin
--restoreDbUsersAndRoles restore user and
role definitions
for the given
database
--dir=<directory-name> input directory,
use '-' for stdin
--gzip decompress gzipped
input
restore options:
--drop drop each
collection before
import
--dryRun view summary
without importing
anything.
recommended with
verbosity
--writeConcern=<write-concern> write concern
options e.g.
--writeConcern
majority,
--writeConcern '{w:
3, wtimeout: 500,
fsync: true, j:
true}'
--noIndexRestore don't restore
indexes
--noOptionsRestore don't restore
collection options
--keepIndexVersion don't update index
version
--maintainInsertionOrder restore the
documents in the
order of their
appearance in the
input source. By
default the
insertions will be
performed in an
arbitrary order.
Setting this flag
also enables the
behavior of
--stopOnError and
restricts
NumInsertionWorkers-
PerCollection to 1.
-j, --numParallelCollections= number of
collections to
restore in parallel
--numInsertionWorkersPerCollection= number of insert
operations to run
concurrently per
collection
--stopOnError halt after
encountering any
error during
insertion. By
default,
mongorestore will
attempt to continue
through document
validation and
DuplicateKey
errors, but with
this option
enabled, the tool
will stop instead.
A small number of
documents may be
inserted after
encountering an
error even with
this option
enabled; use
--maintainInsertion-
Order to halt
immediately after
an error
--bypassDocumentValidation bypass document
validation
--preserveUUID preserve original
collection UUIDs
(off by default,
requires drop)
Options (50)
| Option | Description | Source |
|---|---|---|
--help | print usage | help |
--version | print the tool version and exit | help |
--config | path to a configuration file | help |
-v, --verbose level | more detailed log output (include multiple times for more verbosity, e.g. -vvvvv, or specify a numeric value, e.g. | help |
--quiet | hide all log output | help |
-h, --host hostname | mongodb host to connect to (setname/host1,host- | help |
--port port | server port (can also use --host hostname:port) | help |
--ssl | connect to a mongod or mongos that has ssl enabled | help |
--sslCAFile filename | the .pem file containing the root certificate chain from the certificate authority | help |
--sslPEMKeyFile filename | the .pem file containing the certificate and key | help |
--sslPEMKeyPassword password | the password to decrypt the sslPEMKeyFile, if necessary | help |
--sslCRLFile filename | the .pem file containing the certificate revocation list | help |
--sslFIPSMode | use FIPS mode of the installed openssl library | help |
--tlsInsecure | bypass the validation for server's certificate chain and host name | help |
-u, --username username | username for authentication | help |
-p, --password password | password for authentication | help |
--authenticationDatabase database-name | database that holds the user's credentials | help |
--authenticationMechanism mechanism | authentication mechanism to use | help |
--awsSessionToken aws-session-token | session token to authenticate via AWS IAM | help |
--gssapiServiceName service-name | service name to use when authenticating using GSSAPI/Kerberos (default: mongodb) | help |
--gssapiHostName host-name | hostname to use when authenticating using GSSAPI/Kerberos (default: <remote server's address>) | help |
-d, --db database-name | database to use | help |
-c, --collection collection-name | collection to use | help |
--uri mongodb-uri | mongodb uri connection string | help |
--excludeCollection collection-name | DEPRECATED; | help |
--excludeCollectionsWithPrefix collection-prefix | DEPRECATED; | help |
--nsExclude namespace-pattern | exclude matching namespaces | help |
--nsInclude namespace-pattern | include matching namespaces | help |
--nsFrom namespace-pattern | rename matching namespaces, must have matching nsTo | help |
--nsTo namespace-pattern | rename matched namespaces, must have matching nsFrom | help |
--objcheck | validate all objects before inserting | help |
--oplogReplay | for recovering a point-in-time snapshot on a replica set that is not part of a sharded cluster. | help |
--oplogLimit seconds>[:ordinal | only include oplog entries before the provided Timestamp | help |
--oplogFile filename | oplog file to use for replay of oplog | help |
--archive filename | restore dump from the specified archive file. | help |
--restoreDbUsersAndRoles | restore user and role definitions for the given database | help |
--dir directory-name | input directory, use '-' for stdin | help |
--gzip | decompress gzipped input | help |
--drop | drop each collection before import | help |
--dryRun | view summary without importing anything. | help |
--writeConcern write-concern | write concern options e.g. | help |
--noIndexRestore | don't restore indexes | help |
--noOptionsRestore | don't restore collection options | help |
--keepIndexVersion | don't update index version | help |
--maintainInsertionOrder | restore the documents in the order of their appearance in the input source. | help |
-j, --numParallelCollections | number of collections to restore in parallel | help |
--numInsertionWorkersPerCollection | number of insert operations to run concurrently per collection | help |
--stopOnError | halt after encountering any error during insertion. | help |
--bypassDocumentValidation | bypass document validation | help |
--preserveUUID | preserve original collection UUIDs (off by default, requires drop) | help |