- Reference >
- MongoDB Package Components >
mongofiles
mongofiles
¶
-
mongofiles
¶
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:
The components of the mongofiles
command are:
- Options. You may use one or more of
these options to control the behavior of
mongofiles
. - Commands. Use one of these commands to
determine the action of
mongofiles
. - 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¶
-
--help
¶
Returns a basic help and usage text.
-
--verbose
,
-v
¶
Increases the amount of internal reporting returned on the command line. Increase the verbosity with the
-v
form by including the option multiple times, (e.g.-vvvvv
.)
-
--version
¶
Returns the version of the
mongofiles
utility.
-
--host
<hostname><:port>
¶ Specifies a resolvable hostname for the
mongod
that holds your GridFS system. By defaultmongofiles
attempts to connect to a MongoDB process ruining on the localhost port number27017
.Optionally, specify a port number to connect a MongoDB instance running on a port other than 27017.
-
--port
<port>
¶ Specifies the port number, if the MongoDB instance is not running on the standard port. (i.e.
27017
) You may also specify a port number using themongofiles --host
command.
-
--ipv6
¶
Enables IPv6 support that allows
mongofiles
to connect to the MongoDB instance using an IPv6 network. All MongoDB programs and processes, includingmongofiles
, disable IPv6 support by default.
-
--username
<username>
,
-u
<username>
¶ Specifies a username to authenticate to the MongoDB instance, if your database requires authentication. Use in conjunction with the
mongofiles --password
option to supply a password.
-
--password
<password>
¶ Specifies a password to authenticate to the MongoDB instance. Use in conjunction with the
mongofiles --username
option to supply a username.If you specify a
--username
without the--password
option,mongofiles
will prompt for a password interactively.
-
--dbpath
<path>
¶ Specifies the directory of the MongoDB data files. If used, the
--dbpath
option enablesmongofiles
to attach directly to local data files interact with the GridFS data without themongod
. To run with--dbpath
,mongofiles
needs to lock access to the data directory: as a result, nomongod
can access the same path while the process runs.
-
--directoryperdb
¶
Use the
--directoryperdb
in conjunction with the corresponding option tomongod
, which allowsmongofiles
when running with the--dbpath
option and MongoDB uses 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 when running with--dbpath
to ensure that the database maintains a recoverable state. This forcesmongofiles
to record all data on disk regularly.
-
--db
<db>
,
-d
<db>
¶ Use the
--db
option to specify the MongoDB database that stores or will store the GridFS files.
-
--collection
<collection>
,
-c
<collection>
¶ This option has no use in this context and a future release may remove it. See SERVER-4931 for more information.
-
--local
<filename>
,
-l
<filename>
¶ 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>
,
t
<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, andmongofiles
assumes that this reflects the name the file has on the local file system. If the local filename is different use themongofiles --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, andmongofiles
assumes that this reflects the name the file has on the local file system. If the local filename is different use themongofiles --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:
This mongofiles
instance will connect to the
mongod
instance running on the 27017
localhost
interface to specify the same operation on a different port or
hostname, and issue a command that resembles one of the following:
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:
To delete the 32-corinth.lp
file from this GridFS collection in
the records
database, you can use the following command:
To search for files in the GridFS collection in the records
database that have the string corinth
in their names, you can use
following command:
To list all files in the GridFS collection in the records
database
that begin with the string 32
, you can use the following command:
To fetch the file from the GridFS collection in the records
database named 32-corinth.lp
, you can use the following command: