mongorestore(1)



MONGORESTORE(1)                 mongodb-manual                 MONGORESTORE(1)

NAME
       mongorestore - MongoDB Data Restoration Tool

SYNOPSIS
       The  mongorestore  program writes data from a binary database dump cre-
       ated by mongodump to a MongoDB instance. mongorestore can create a  new
       database or add data to an existing database.

       mongorestore  can  write  data to either mongod or mongos instances, in
       addition to writing directly to MongoDB data files  without  an  active
       mongod.

BEHAVIOR
       If  you  restore to an existing database, mongorestore will only insert
       into the existing database, and does not perform updates of  any  kind.
       If existing documents have the same value _id field in the target data-
       base and collection, mongorestore will not overwrite those documents.

       Remember the following properties of mongorestore behavior:

       o mongorestore recreates indexes recorded by mongodump.

       o all operations are inserts, not updates.

       o mongorestore does not wait for a response from  a  mongod  to  ensure
         that the MongoDB process has received or recorded the operation.

         The  mongod  will  record  any  errors to its log that occur during a
         restore operation, but mongorestore will not receive errors.

       The data format used by mongodump from version 2.2 or later  is  incom-
       patible with earlier versions of mongod.  Do not use recent versions of
       mongodump to back up older data stores.

REQUIRED ACCESS TO RESTORE USER DATA
       Changed in version 2.6.

       To restore users and user-defined roles on a given database,  you  must
       have  access  to  the  admin database. MongoDB stores the user data and
       role definitions for all databases in the admin database.

       Specifically, to restore users to a given database, you must  have  the
       insert  action  on  the admin database's admin.system.users collection.
       The restore role provides this privilege.

       To restore user-defined roles to a database, you must have  the  insert
       action  on  the  admin  database's  admin.system.roles  collection. The
       restore role provides this privilege.

OPTIONS
       mongorestore

       mongorestore

       --help, -h
              Returns information on mongorestore options and usage.

       --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 mongorestore in a quiet mode that  attempts  to  limit  the
              amount of output. This option suppresses:

              o output from database commands

              o replication activity

              o connection accepted events

              o connection closed events

       --version
              Returns the mongorestore release number.

       --host <hostname><:port>, -h
              Specifies  a resolvable hostname for the mongod to which to con-
              nect. By default mongorestore attempts to connect to  a  MongoDB
              instance running on the localhost on port number 27017.

              To  connect  to a replica set, specify the replica set seed name
              and the seed list of set members. Use the following format:

                 <replica_set_name>/<hostname1><:port>,<hostname2:<port>,...

              You can always connect directly to a single MongoDB instance  by
              specifying the host and port number directly.

       --port <port>
              Specifies  the port number when the MongoDB instance is not run-
              ning on the standard port of 27017. You  may  also  specify  the
              port number using the --host option.

       --ipv6 Enables  IPv6  support,  which allows mongorestore to connect to
              the MongoDB instance using an IPv6 network. All MongoDB programs
              and  processes,  including mongorestore, disable IPv6 support by
              default.

       --ssl  New in version 2.6.

              Enables connection to a mongod or mongos that  has  SSL  support
              enabled.

              The default distribution of MongoDB does not contain support for
              SSL.   For  more   information   on   MongoDB   and   SSL,   see
              http://docs.mongodb.org/manual/tutorial/configure-ssl.

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

              The default distribution of MongoDB does not contain support for
              SSL.   For  more   information   on   MongoDB   and   SSL,   see
              http://docs.mongodb.org/manual/tutorial/configure-ssl.

       --sslPEMKeyFile <filename>
              New in version 2.6.

              Specifies  the  .pem file that contains both the 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 a  mongod  or  mongos  that  has  sslCAFile  enabled  without
              sslWeakCertificateValidation.

              The default distribution of MongoDB does not contain support for
              SSL.   For  more   information   on   MongoDB   and   SSL,   see
              http://docs.mongodb.org/manual/tutorial/configure-ssl.

       --sslPEMKeyPassword <value>
              New in version 2.6.

              Specifies  the  password  to  de-crypt  the certificate-key file
              (i.e.  --sslPEMKeyFile). Use  --sslPEMKeyPassword  only  if  the
              certificate-key  file  is  encrypted. In all cases, 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  --sslPEMKeyPassword,  mongorestore  will  prompt  for a
              passphrase.  See ssl-certificate-password.

              The default distribution of MongoDB does not contain support for
              SSL.    For   more   information   on   MongoDB   and  SSL,  see
              http://docs.mongodb.org/manual/tutorial/configure-ssl.

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

              The default distribution of MongoDB does not contain support for
              SSL.    For   more   information   on   MongoDB   and  SSL,  see
              http://docs.mongodb.org/manual/tutorial/configure-ssl.

       --sslAllowInvalidCertificates
              New in version 2.6.

              Bypasses the  validation  checks  for  server  certificates  and
              allows the use of invalid certificates. When using the sslAllow-
              InvalidCertificates setting, MongoDB logs as a warning  the  use
              of the invalid certificate.

              The default distribution of MongoDB does not contain support for
              SSL.   For  more   information   on   MongoDB   and   SSL,   see
              http://docs.mongodb.org/manual/tutorial/configure-ssl.

       --sslFIPSMode
              New in version 2.6.

              Directs  mongorestore  to  use  the  FIPS  mode of the installed
              OpenSSL library. Your system must have a FIPS compliant  OpenSSL
              library to use --sslFIPSMode.

              The default distribution of MongoDB does not contain support for
              SSL.   For  more   information   on   MongoDB   and   SSL,   see
              http://docs.mongodb.org/manual/tutorial/configure-ssl.

       --username <username>, -u
              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
              Specifies  a  password  with  which to authenticate to a MongoDB
              database that uses authentication. Use in conjunction  with  the
              --username and --authenticationDatabase options.

       --authenticationDatabase <dbname>
              New in version 2.4.

              Specifies  the  database  that holds the user's credentials.  If
              you do not  specify  an  authentication  database,  mongorestore
              assumes  that the database specified as the argument to the --db
              option holds the user's credentials.

       --authenticationMechanism <name>
              New in version 2.4.

              Specifies the authentication mechanism. By default, the  authen-
              tication  mechanism  is  MONGODB-CR,  which is the MongoDB chal-
              lenge/response authentication mechanism. In MongoDB  Enterprise,
              mongorestore also includes support for GSSAPI to handle Kerberos
              authentication. See http://docs.mongodb.org/manual/tutorial/con-
              trol-access-to-mongodb-with-kerberos-authentication   for   more
              information about Kerberos authentication.

       --dbpath <path>
              Specifies the directory of the MongoDB data files. If used,  the
              --dbpath option enables mongorestore to attach directly to local
              data files without a running mongod.  When  run  with  --dbpath,
              mongorestore  locks  access to the data directory. No mongod can
              access the same path while the process runs.

       --directoryperdb
              When used in conjunction with the corresponding option  in  mon-
              god,  allows  mongorestore to access data from MongoDB instances
              that use an on-disk format where every database has  a  distinct
              directory.  This  option  is  only  relevant when specifying the
              --dbpath option.

       --journal
              Allows mongorestore operations to use the durability journal  to
              ensure  data  files remain valid and recoverable. This option is
              only relevant when specifying the --dbpath option.

       --db <database>, -d
              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  Mon-
              goDB 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
              Specifies  a  single  collection for mongorestore to restore. If
              you do not specify --collection, mongorestore takes the  collec-
              tion  name  from  the  input  filename. If the input file has an
              extension, MongoDB omits the extension of the file from the col-
              lection 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-docu-
              ment nesting, --objcheck can have a small impact on performance.
              You can set --noobjcheck to disable object checking at run-time.

              Changed  in  version 2.4: MongoDB enables --objcheck by default,
              to prevent any client from inserting malformed or  invalid  BSON
              into a MongoDB database.

       --noobjcheck
              New in version 2.4.

              Disables  the  default document validation that MongoDB performs
              on all incoming BSON documents.

       --filter <JSON>
              Limits the documents that mongorestore  imports  to  only  those
              documents that match the JSON document specified as '<JSON>'. Be
              sure to include the document in single quotes to avoid  interac-
              tion  with  your  system's  shell environment. For an example of
              --filter, see backup-restore-filter.

       --drop Modifies the restoration procedure to drop every collection from
              the  target  database  before  restoring the collection from the
              dumped backup.

       --oplogReplay
              Replays the oplog after restoring the dump to  ensure  that  the
              current  state of the database reflects the point-in-time backup
              captured with the "mongodump --oplog" command. For an example of
              --oplogReplay, see backup-restore-oplogreplay.

       --oplogLimit <timestamp>
              New in version 2.2.

              Prevents mongorestore from applying oplog entries newer than the
              <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
              New in version 2.2.

              Prevents  mongorestore  from  restoring  and building indexes as
              specified in the corresponding mongodump output.

       --noOptionsRestore
              New in version 2.2.

              Prevents mongorestore from setting the collection options,  such
              as  those specified by the collMod database command, on restored
              collections.

       --w <number of replicas per write>
              New in version 2.2.

              Specifies the write concern for each write operation  that  mon-
              gorestore  writes  to  the target database. By default, mongore-
              store does not wait for a response for write acknowledgment.

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

USE
       See http://docs.mongodb.org/manual/tutorial/backup-with-mongodump for a
       larger  overview of mongorestore usage. Also see the mongodump document
       for an overview of the mongodump, which provides  the  related  inverse
       functionality.

       Consider the following example:

          mongorestore --collection people --db accounts dump/accounts/people.bson

       Here,  mongorestore  reads the database dump in the dump/ sub-directory
       of the current directory, and restores only the documents in  the  col-
       lection  named  people  from  the database named accounts. mongorestore
       restores data to the instance running on  the  localhost  interface  on
       port 27017.

       In  the  next  example,  mongorestore restores a backup of the database
       instance located in dump to a database instance stored in the /srv/mon-
       godb  on the local machine. This requires that there are no active mon-
       god instances attached to /srv/mongodb data directory.

          mongorestore --dbpath /srv/mongodb

       In the final 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  authenti-
       cates  to the MongoDB instance using the username user and the password
       pass, as follows:

          mongorestore --host mongodb1.example.net --port 37017 --username user --password pass /opt/backup/mongodump-2011-10-24

AUTHOR
       MongoDB Documentation Project

COPYRIGHT
       2011-2014, MongoDB, Inc.

2.6                             March 18, 2014                 MONGORESTORE(1)

Man(1) output converted with man2html
list of all man pages