380 lines
12 KiB
Groff
380 lines
12 KiB
Groff
.TH "MONGOIMPORT" "1" "March 14, 2013" "2.2.3" "mongodb-manual"
|
|
.SH NAME
|
|
mongoimport \- MongoDB
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.\" Man page generated from reStructuredText.
|
|
.
|
|
.SH SYNOPSIS
|
|
.sp
|
|
The \fI\%mongoimport\fP tool provides a route to import content from a
|
|
JSON, CSV, or TSV export created by \fBmongoexport\fP, or
|
|
potentially, another third\-party export tool. See the
|
|
"\fB/administration/import\-export\fP" document for a more in depth
|
|
usage overview, and the "\fBmongoexport\fP" document for more
|
|
information regarding \fBmongoexport\fP, which
|
|
provides the inverse "importing" capability.
|
|
.IP Note
|
|
Do not use \fI\%mongoimport\fP and \fBmongoexport\fP for
|
|
full instance, production backups because they will not reliably capture data type
|
|
information. Use \fBmongodump\fP and \fBmongorestore\fP as
|
|
described in "\fB/administration/backups\fP" for this kind of
|
|
functionality.
|
|
.RE
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B mongoimport
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-help
|
|
Returns a basic help and usage text.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-verbose, \-v
|
|
Increases the amount of internal reporting returned on the command
|
|
line. Increase the verbosity with the \fB\-v\fP form by including
|
|
the option multiple times, (e.g. \fB\-vvvvv\fP.)
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-version
|
|
Returns the version of the \fI\%mongoimport\fP program.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-host <hostname><:port>, \-h
|
|
Specifies a resolvable hostname for the \fBmongod\fP to which
|
|
you want to restore the database. By default \fI\%mongoimport\fP
|
|
will attempt to connect to a MongoDB process ruining on the
|
|
localhost port numbered \fB27017\fP.
|
|
.sp
|
|
Optionally, specify a port number to connect a MongoDB instance
|
|
running on a port other than \fB27017\fP.
|
|
.sp
|
|
To connect to a replica set, use the \fI\%--host\fP argument with a
|
|
setname, followed by a slash and a comma\-separated list of host and
|
|
port names. \fI\%mongoimport\fP will, given the seed of at least
|
|
one connected set member, connect to primary node of that set. This
|
|
option would resemble:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
\-\-host repl0/mongo0.example.net,mongo0.example.net:27018,mongo1.example.net,mongo2.example.net
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
You can always connect directly to a single MongoDB instance by
|
|
specifying the host and port number directly.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-port <port>
|
|
Specifies the port number, if the MongoDB instance is not running on
|
|
the standard port. (i.e. \fB27017\fP) You may also specify a port
|
|
number using the \fI\%mongoimport --host\fP command.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-ipv6
|
|
Enables IPv6 support that allows \fI\%mongoimport\fP to connect
|
|
to the MongoDB instance using an IPv6 network. All MongoDB programs
|
|
and processes, including \fI\%mongoimport\fP, disable IPv6
|
|
support by default.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-ssl
|
|
New in version 2.4: MongoDB added support for SSL connections to \fBmongod\fP
|
|
instances in mongoimport.
|
|
.IP Note
|
|
SSL support in mongoimport is not compiled into the default
|
|
distribution of MongoDB. See \fB/administration/ssl\fP for more
|
|
information on SSL and MongoDB.
|
|
.sp
|
|
Additionally, mongoimport does not support connections to
|
|
\fBmongod\fP instances that require client certificate
|
|
validation.
|
|
.RE
|
|
.sp
|
|
Allows \fI\%mongoimport\fP to connect to \fBmongod\fP
|
|
instance over an SSL connection.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-username <username>, \-u <username>
|
|
Specifies a username to authenticate to the MongoDB instance, if your
|
|
database requires authentication. Use in conjunction with the
|
|
\fI\%mongoimport --password\fP option to supply a password.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-password <password>, \-p <password>
|
|
Specifies a password to authenticate to the MongoDB instance. Use
|
|
in conjunction with the \fI\%mongoimport --username\fP option to
|
|
supply a username.
|
|
.sp
|
|
If you specify a \fI\%--username\fP
|
|
without the \fI\%--password\fP option, \fI\%mongoimport\fP
|
|
will prompt for a password interactively.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-authenticationDatabase <dbname>
|
|
New in version 2.4.
|
|
.sp
|
|
Specifies the database that holds the user\(aqs (e.g
|
|
\fI\%--username\fP) credentials.
|
|
.sp
|
|
By default, \fI\%mongoimport\fP assumes that the database specified to the
|
|
\fI\%--db\fP argument holds the user\(aqs credentials, unless you
|
|
specify \fI\%--authenticationDatabase\fP.
|
|
.sp
|
|
See \fBuserSource\fP,
|
|
\fB/reference/privilege\-documents\fP and
|
|
\fB/reference/user\-privileges\fP for more information about
|
|
delegated authentication in MongoDB.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-authenticationMechanism <name>
|
|
New in version 2.4.
|
|
.sp
|
|
Specifies the authentication mechanism. By default, the
|
|
authentication mechanism is \fBMONGODB\-CR\fP, which is the MongoDB
|
|
challenge/response authentication mechanism. In the MongoDB Subscriber Edition,
|
|
\fI\%mongoimport\fP also includes support for \fBGSSAPI\fP to handle
|
|
Kerberos authentication.
|
|
.sp
|
|
See \fB/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication\fP
|
|
for more information about Kerberos authentication.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-dbpath <path>
|
|
Specifies the directory of the MongoDB data files. If used, the
|
|
\fI\%--dbpath\fP option enables
|
|
\fI\%mongoimport\fP to attach directly to local data files and
|
|
insert the data without the \fBmongod\fP. To run with
|
|
\fB\-\-dbpath\fP, \fI\%mongoimport\fP needs to lock access to the
|
|
data directory: as a result, no \fBmongod\fP can access the
|
|
same path while the process runs.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-directoryperdb
|
|
Use the \fI\%--directoryperdb\fP in conjunction with the
|
|
corresponding option to \fBmongod\fP, which allows
|
|
\fI\%mongoimport\fP to import data into MongoDB instances that
|
|
have every database\(aqs files saved in discrete directories on the
|
|
disk. This option is only relevant when specifying the
|
|
\fI\%--dbpath\fP option.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-journal
|
|
Allows \fBmongoexport\fP write to the durability
|
|
\fIjournal\fP to ensure that the data files will remain in a
|
|
consistent state during the write process. This option is only
|
|
relevant when specifying the \fI\%--dbpath\fP option.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-db <db>, \-d <db>
|
|
Use the \fI\%--db\fP option to specify a database for
|
|
\fI\%mongoimport\fP to restore data. If you do not specify a
|
|
\fB<db>\fP, \fI\%mongoimport\fP 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, or to restore only some data in the
|
|
specified backup.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-collection <collection>, \-c <collection>
|
|
Use the \fI\%--collection\fP option to specify a collection for
|
|
\fBmongorestore\fP to restore. If you do not specify a
|
|
\fB<collection>\fP, \fI\%mongoimport\fP imports all collections
|
|
created. Existing data may be overwritten. Use this option to
|
|
restore data into a MongoDB instance that already has data, or to
|
|
restore only some data in the specified imported data set.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-fields <field1<,filed2>>, \-f <field1[,filed2]>
|
|
Specify a comma seperatedlist of field names when importing
|
|
\fIcsv\fP or \fItsv\fP files that do not have field names in
|
|
the first (i.e. header) line of the file.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-fieldFile <filename>
|
|
As an alternative to \fI\%--fields\fP the \fI\%--fieldFile\fP
|
|
option allows you to specify a file (e.g. \fB<file>\(ga\fP) to that
|
|
holds a list of field names if your \fIcsv\fP or \fItsv\fP
|
|
file does not include field names in the first (i.e. header) line
|
|
of the file. Place one field per line.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-ignoreBlanks
|
|
In \fIcsv\fP and \fItsv\fP exports, ignore empty fields. If not
|
|
specified, \fI\%mongoimport\fP creates fields without values in
|
|
imported documents.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-type <json|csv|tsv>
|
|
Declare the type of export format to import. The default format is
|
|
\fIJSON\fP, but it\(aqs possible to import \fIcsv\fP and
|
|
\fItsv\fP files.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-file <filename>
|
|
Specify the location of a file containing the data to
|
|
import. \fI\%mongoimport\fP will read data from standard input
|
|
(e.g. "stdin.") if you do not specify a file.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-drop
|
|
Modifies the importation procedure so that the target instance
|
|
drops every collection before restoring the collection from the
|
|
dumped backup.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-headerline
|
|
If using "\fI\%--type csv\fP" or
|
|
"\fI\%--type tsv\fP," use the first line as
|
|
field names. Otherwise, \fI\%mongoimport\fP will import the first
|
|
line as a distinct document.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-upsert
|
|
Modifies the import process to update existing objects in the
|
|
database if they match an imported object, while inserting all
|
|
other objects.
|
|
.sp
|
|
If you do not specify a field or fields using the
|
|
\fI\%--upsertFields\fP \fI\%mongoimport\fP will upsert on the
|
|
basis of the \fB_id\fP field.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-upsertFields <field1[,field2]>
|
|
Specifies a list of fields for the query portion of the
|
|
\fIupsert\fP. Use this option if the \fB_id\fP fields in the
|
|
existing documents don\(aqt match the field in the document, but
|
|
another field or field combination can uniquely identify
|
|
documents as a basis for performing upsert operations.
|
|
.sp
|
|
To ensure adequate performance, indexes should exist for this
|
|
field or fields.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-stopOnError
|
|
New in version 2.2.
|
|
.sp
|
|
Forces \fI\%mongoimport\fP to halt the import operation at the
|
|
first error rather than continuing the operation despite errors.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-jsonArray
|
|
Changed in version 2.2: The limit on document size increased from 4MB to 16MB.
|
|
.sp
|
|
Accept import of data expressed with multiple MongoDB document
|
|
within a single \fIJSON\fP array.
|
|
.sp
|
|
Use in conjunction with \fImongoexport \-\-jsonArray\fP to
|
|
import data written as a single \fIJSON\fP array. Limited to
|
|
imports of 16 MB or smaller.
|
|
.UNINDENT
|
|
.SH USAGE
|
|
.sp
|
|
In this example, \fI\%mongoimport\fP imports the \fIcsv\fP
|
|
formatted data in the \fB/opt/backups/contacts.csv\fP into the
|
|
collection \fBcontacts\fP in the \fBusers\fP database on the MongoDB
|
|
instance running on the localhost port numbered \fB27017\fP.
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongoimport \-\-db users \-\-collection contacts \-\-type csv \-\-file /opt/backups/contacts.csv
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
In the following example, \fI\%mongoimport\fP imports the data in
|
|
the \fIJSON\fP formatted file \fBcontacts.json\fP into the collection
|
|
\fBcontacts\fP on the MongoDB instance running on the localhost port
|
|
number 27017. Journaling is explicitly enabled.
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongoimport \-\-collection contacts \-\-file contacts.json \-\-journal
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
In the next example, \fI\%mongoimport\fP takes data passed to it on
|
|
standard input (i.e. with a \fB|\fP pipe.) and imports it into the
|
|
collection \fBcontacts\fP in the \fBsales\fP database is the
|
|
MongoDB datafiles located at \fB/srv/mongodb/\fP. if the import process
|
|
encounters an error, the \fI\%mongoimport\fP will halt because of
|
|
the \fI\%--stopOnError\fP option.
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongoimport \-\-db sales \-\-collection contacts \-\-stopOnError \-\-dbpath /srv/mongodb/
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
In the final example, \fI\%mongoimport\fP imports data from the
|
|
file \fB/opt/backups/mdb1\-examplenet.json\fP into the collection
|
|
\fBcontacts\fP within the database \fBmarketing\fP on a remote MongoDB
|
|
database. This \fI\%mongoimport\fP accesses the \fBmongod\fP
|
|
instance running on the host \fBmongodb1.example.net\fP over port
|
|
\fB37017\fP, which requires the username \fBuser\fP and the password
|
|
\fBpass\fP.
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
mongoimport \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-password pass \-\-collection contacts \-\-db marketing \-\-file /opt/backups/mdb1\-examplenet.json
|
|
.ft P
|
|
.fi
|
|
.SH AUTHOR
|
|
MongoDB Documentation Project
|
|
.SH COPYRIGHT
|
|
2011-2013, 10gen, Inc.
|
|
.\" Generated by docutils manpage writer.
|
|
.
|