.\" Man page generated from reStructuredText. . .TH "MONGOIMPORT" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME mongoimport \- MongoDB Import Utility . .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 .. .SH SYNOPSIS .sp The \fBmongoimport\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 http://docs.mongodb.org/manual/core/import\-export document for a more in depth usage overview, and the \fBmongoexport\fP document for more information regarding \fBmongoexport\fP, which provides the inverse "exporting" capability. .SH CONSIDERATIONS .sp Do not use \fBmongoimport\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 http://docs.mongodb.org/manual/core/backups for this kind of functionality. .SH OPTIONS .INDENT 0.0 .TP .B mongoimport .UNINDENT .INDENT 0.0 .TP .B mongoimport .UNINDENT .INDENT 0.0 .TP .B \-\-help, \-h Returns information on \fBmongoimport\fP options and usage. .UNINDENT .INDENT 0.0 .TP .B \-\-verbose, \-v Increases the amount of internal reporting returned on standard output or in log files. 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 \-\-quiet Runs \fBmongoimport\fP in a quiet mode that attempts to limit the amount of output. This option suppresses: .INDENT 7.0 .IP \(bu 2 output from \fIdatabase commands\fP .IP \(bu 2 replication activity .IP \(bu 2 connection accepted events .IP \(bu 2 connection closed events .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-version Returns the \fBmongoimport\fP release number. .UNINDENT .INDENT 0.0 .TP .B \-\-host <:port>, \-h Specifies a resolvable hostname for the \fBmongod\fP to which to connect. By default \fBmongoimport\fP attempts to connect to a MongoDB instance running on the localhost on port number \fB27017\fP\&. .sp To connect to a replica set, specify the replica set seed name and the seed list of set members. Use the following format: .INDENT 7.0 .INDENT 3.5 .sp .nf .ft C /<:port>,,... .ft P .fi .UNINDENT .UNINDENT .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 Specifies the port number when the MongoDB instance is not running on the standard port of \fB27017\fP\&. You may also specify the port number using the \fB\-\-host\fP option. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 Enables IPv6 support, which allows \fBmongoimport\fP to connect to the MongoDB instance using an IPv6 network. All MongoDB programs and processes, including \fBmongoimport\fP, disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP .B \-\-ssl New in version 2.6. .sp Enables connection to a \fBmongod\fP or \fBmongos\fP that has SSL support enabled. .sp 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\&. .UNINDENT .INDENT 0.0 .TP .B \-\-sslCAFile New in version 2.6. .sp Specifies the \fB\&.pem\fP file that contains the root certificate chain from the Certificate Authority. Specify the file name of the \fB\&.pem\fP file using relative or absolute paths. .sp 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\&. .UNINDENT .INDENT 0.0 .TP .B \-\-sslPEMKeyFile New in version 2.6. .sp Specifies the \fB\&.pem\fP file that contains both the SSL certificate and key. Specify the file name of the \fB\&.pem\fP file using relative or absolute paths. .sp This option is required when using the \fI\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has \fBsslCAFile\fP enabled \fIwithout\fP \fBsslWeakCertificateValidation\fP\&. .sp 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\&. .UNINDENT .INDENT 0.0 .TP .B \-\-sslPEMKeyPassword New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. \fI\-\-sslPEMKeyFile\fP). Use \fI\-\-sslPEMKeyPassword\fP only if the certificate\-key file is encrypted. In all cases, \fBmongoimport\fP will redact the password from all logging and reporting output. .sp If the private key in the PEM file is encrypted and you do not specify \fI\-\-sslPEMKeyPassword\fP, \fBmongoimport\fP will prompt for a passphrase. See \fIssl\-certificate\-password\fP\&. .sp 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\&. .UNINDENT .INDENT 0.0 .TP .B \-\-sslCRLFile New in version 2.6. .sp Specifies the \fB\&.pem\fP file that contains the Certificate Revocation List. Specify the file name of the \fB\&.pem\fP file using relative or absolute paths. .sp 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\&. .UNINDENT .INDENT 0.0 .TP .B \-\-sslAllowInvalidCertificates New in version 2.6. .sp Bypasses the validation checks for server certificates and allows the use of invalid certificates. When using the \fBsslAllowInvalidCertificates\fP setting, MongoDB logs as a warning the use of the invalid certificate. .sp 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\&. .UNINDENT .INDENT 0.0 .TP .B \-\-sslFIPSMode New in version 2.6. .sp Directs \fBmongoimport\fP to use the FIPS mode of the installed OpenSSL library. Your system must have a FIPS compliant OpenSSL library to use \fI\-\-sslFIPSMode\fP\&. .sp 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\&. .UNINDENT .INDENT 0.0 .TP .B \-\-username , \-u Specifies a username with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-password\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP .B \-\-password , \-p Specifies a password with which to authenticate to a MongoDB database that uses authentication. Use in conjunction with the \fB\-\-username\fP and \fB\-\-authenticationDatabase\fP options. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationDatabase New in version 2.4. .sp Specifies the database that holds the user\(aqs credentials. If you do not specify an authentication database, \fBmongoimport\fP assumes that the database specified as the argument to the \fI\-\-db\fP option holds the user\(aqs credentials. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism 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 MongoDB Enterprise, \fBmongoimport\fP also includes support for \fBGSSAPI\fP to handle Kerberos authentication. See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication for more information about Kerberos authentication. .UNINDENT .INDENT 0.0 .TP .B \-\-dbpath Specifies the directory of the MongoDB data files. If used, the \fI\-\-dbpath\fP option enables \fBmongoimport\fP to attach directly to local data files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP, \fBmongoimport\fP locks access to the data directory. No \fBmongod\fP can access the same path while the process runs. .UNINDENT .INDENT 0.0 .TP .B \-\-directoryperdb When used in conjunction with the corresponding option in \fBmongod\fP, allows \fBmongoimport\fP 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 \fI\-\-dbpath\fP option. .UNINDENT .INDENT 0.0 .TP .B \-\-journal Allows \fBmongoimport\fP operations to use the durability \fIjournal\fP to ensure data files remain valid and recoverable. This option is only relevant when specifying the \fI\-\-dbpath\fP option. .UNINDENT .INDENT 0.0 .TP .B \-\-db , \-d Specifies the name of the database on which to run \fBmongoimport\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-collection , \-c Specifies the collection to import. .sp New in version 2.6: If you do not specify \fI\-\-collection\fP, \fBmongoimport\fP takes the collection name from the input filename. MongoDB omits the extension of the file from the collection name, if the input file has an extension. .UNINDENT .INDENT 0.0 .TP .B \-\-fields , \-f Specify a comma separated list 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 As an alternative to \fI\%\-\-fields\fP, the \fI\%\-\-fieldFile\fP option allows you to specify a file that holds a list of field names if your \fIcsv\fP or \fItsv\fP file does not include field names in the first line of the file (i.e. header). Place one field per line. .UNINDENT .INDENT 0.0 .TP .B \-\-ignoreBlanks Ignores empty fields in \fIcsv\fP and \fItsv\fP exports. If not specified, \fBmongoimport\fP creates fields without values in imported documents. .UNINDENT .INDENT 0.0 .TP .B \-\-type Specifies the file type 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 Specifies the location and name of a file containing the data to import. If you do not specify a file, \fBmongoimport\fP reads data from standard input (e.g. "stdin"). .UNINDENT .INDENT 0.0 .TP .B \-\-drop Modifies the import process so that the target instance drops every collection before importing the collection from the input. .UNINDENT .INDENT 0.0 .TP .B \-\-headerline If using \fI\-\-type csv\fP or \fI\-\-type tsv\fP, uses the first line as field names. Otherwise, \fBmongoimport\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 \fBmongoimport\fP will upsert on the basis of the \fB_id\fP field. .UNINDENT .INDENT 0.0 .TP .B \-\-upsertFields 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 \fBmongoimport\fP to halt the import operation at the first error rather than continuing the operation despite errors. .UNINDENT .INDENT 0.0 .TP .B \-\-jsonArray Accepts the import of data expressed with multiple MongoDB documents within a single \fIJSON\fP array. .sp Used 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 USE .sp In this example, \fBmongoimport\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\&. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C mongoimport \-\-db users \-\-collection contacts \-\-type csv \-\-file /opt/backups/contacts.csv .ft P .fi .UNINDENT .UNINDENT .sp Since \fBmongoimport\fP uses the input file name (minus the extension) as the collection name if \fB\-c\fP or \fB\-\-collection\fP is unspecified, the following example is equivalent to the previous example: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C mongoimport \-\-db users \-\-type csv \-\-file /opt/backups/contacts.csv .ft P .fi .UNINDENT .UNINDENT .sp In the following example, \fBmongoimport\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. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C mongoimport \-\-collection contacts \-\-file contacts.json .ft P .fi .UNINDENT .UNINDENT .sp In the next example, \fBmongoimport\fP takes data passed to it on standard input (i.e. with a \fB|\fP pipe.) and imports it into the MongoDB datafiles located at \fB/srv/mongodb/\fP\&. if the import process encounters an error, the \fBmongoimport\fP will halt because of the \fI\-\-stopOnError\fP option. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C mongoimport \-\-db sales \-\-collection contacts \-\-stopOnError \-\-dbpath /srv/mongodb/ .ft P .fi .UNINDENT .UNINDENT .sp In the final example, \fBmongoimport\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 \fBmongoimport\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\&. .INDENT 0.0 .INDENT 3.5 .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 .UNINDENT .UNINDENT .SH TYPE FIDELITY .sp \fBWARNING:\fP .INDENT 0.0 .INDENT 3.5 \fBmongoimport\fP and \fBmongoexport\fP do not reliably preserve all rich \fIBSON\fP data types because \fIJSON\fP can only represent a subset of the types supported by BSON. As a result, data exported or imported with these tools may lose some measure of fidelity. See http://docs.mongodb.org/manual/reference/mongodb\-extended\-json for more information. .UNINDENT .UNINDENT .sp JSON can only represent a subset of the types supported by BSON. To preserve type information, \fBmongoimport\fP accepts \fBstrict mode representation\fP for certain types. .sp For example, to preserve type information for BSON types \fBdata_date\fP and \fBdata_numberlong\fP during \fBmongoimport\fP, the data should be in strict mode representation, as in the following: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C { "_id" : 1, "volume" : { "$numberLong" : "2980000" }, "date" : { "$date" : "2014\-03\-13T13:47:42.483\-0400" } } .ft P .fi .UNINDENT .UNINDENT .sp For the \fBdata_numberlong\fP type, \fBmongoimport\fP converts into a float during the import. .sp See http://docs.mongodb.org/manual/reference/mongodb\-extended\-json for a complete list of these types and the representations used. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT 2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. .