mongofiles(1)



MONGOFILES(1)                   mongodb-manual                   MONGOFILES(1)

NAME
       mongofiles - MongoDB GridFS Utility

SYNOPSIS
       The  mongofiles utility makes it possible to manipulate files stored in
       your MongoDB instance in GridFS objects from the command  line.  It  is
       particularly  useful as it provides an interface between objects stored
       in your file system and GridFS.

       All mongofiles commands have the following form:

          mongofiles <options> <commands> <filename>

       The components of the mongofiles command are:

       1. Options. You may use one or more of these  options  to  control  the
          behavior of mongofiles.

       2. Commands.  Use one of these commands to determine the action of mon-
          gofiles.

       3. A filename which is either: the name of a file on your local's  file
          system, or a GridFS object.

       mongofiles, like mongodump, mongoexport, mongoimport, and mongorestore,
       can access data stored in a MongoDB data directory without requiring  a
       running mongod instance, if no other mongod is running.

       IMPORTANT:
          For replica sets, mongofiles can only read from the set's 'primary.

OPTIONS
       mongofiles

       --help, -h
              Returns information on mongofiles 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  mongofiles  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 mongofiles release number.

       --host <hostname><:port>
              Specifies a resolvable hostname for the mongod that  holds  your
              GridFS  system.  By  default mongofiles attempts to connect to a
              MongoDB process running on the localhost port number 27017.

              Optionally, specify a port number to connect a MongoDB  instance
              running on a port other than 27017.

       --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 mongofiles to connect to the
              MongoDB instance using an IPv6 network. All MongoDB programs and
              processes,   including   mongofiles,  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, mongofiles 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,  mongofiles  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 mongofiles 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,  mongofiles
              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,
              mongofiles  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 mongofiles to attach directly to local
              data files without a running mongod.  When  run  with  --dbpath,
              mongofiles  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  mongofiles  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 mongofiles 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 the name of the database on which to run mongofiles.

       --collection <collection>, -c
              This option has no use in this context and a future release  may
              remove it. See SERVER-4931 for more information.

       --local <filename>, -l
              Specifies  the  local  filesystem name of a file for get and put
              operations.

              In the mongofiles put and mongofiles get commands, the  required
              <filename>  modifier  refers to the name the object will have in
              GridFS. mongofiles assumes that this reflects the file's name on
              the local file system. This setting overrides this default.

       --type <MIME>
              Provides the ability to specify a MIME type to describe the file
              inserted into GridFS storage. mongofiles omits  this  option  in
              the default operation.

              Use only with mongofiles put operations.

       --replace, -r
              Alters the behavior of mongofiles put to replace existing GridFS
              objects with the specified local file,  rather  than  adding  an
              additional object with the same name.

              In  the  default  operation,  files will not be overwritten by a
              mongofiles put option.

COMMANDS
       list <prefix>
              Lists the files in the GridFS store.  The  characters  specified
              after list (e.g. <prefix>) optionally limit the list of returned
              items to files that begin with that string of characters.

       search <string>
              Lists the files in the GridFS store with names  that  match  any
              portion of <string>.

       put <filename>
              Copy  the  specified file from the local file system into GridFS
              storage.

              Here, <filename> refers to the name  the  object  will  have  in
              GridFS,  and  mongofiles assumes that this reflects the name the
              file has on the local file system. If the local filename is dif-
              ferent use the mongofiles --local option.

       get <filename>
              Copy  the  specified  file from GridFS storage to the local file
              system.

              Here, <filename> refers to the name  the  object  will  have  in
              GridFS,  and  mongofiles assumes that this reflects the name the
              file has on the local file system. If the local filename is dif-
              ferent use the mongofiles --local option.

       delete <filename>
              Delete the specified file from GridFS storage.

EXAMPLES
       To  return  a  list  of all files in a GridFS collection in the records
       database, use the following invocation at the system shell:

          mongofiles -d records list

       This mongofiles instance will connect to the mongod instance running on
       the  27017  localhost interface to specify the same operation on a dif-
       ferent port or hostname, and issue a command that resembles one of  the
       following:

          mongofiles --port 37017 -d records list
          mongofiles --hostname db1.example.net -d records list
          mongofiles --hostname db1.example.net --port 37017 -d records list

       Modify any of the following commands as needed if you're connecting the
       mongod instances on different ports or hosts.

       To upload a file named 32-corinth.lp to the GridFS  collection  in  the
       records database, you can use the following command:

          mongofiles -d records put 32-corinth.lp

       To  delete  the  32-corinth.lp  file from this GridFS collection in the
       records database, you can use the following command:

          mongofiles -d records delete 32-corinth.lp

       To search for files in the GridFS collection in  the  records  database
       that have the string corinth in their names, you can use following com-
       mand:

          mongofiles -d records search corinth

       To list all files in the GridFS collection in the records database that
       begin with the string 32, you can use the following command:

          mongofiles -d records list 32

       To  fetch  the  file from the GridFS collection in the records database
       named 32-corinth.lp, you can use the following command:

          mongofiles -d records get 32-corinth.lp

AUTHOR
       MongoDB Documentation Project

COPYRIGHT
       2011-2014, MongoDB, Inc.

2.6                             March 18, 2014                   MONGOFILES(1)

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