diff options
Diffstat (limited to 'debian/mongoexport.1')
| -rw-r--r-- | debian/mongoexport.1 | 668 |
1 files changed, 504 insertions, 164 deletions
diff --git a/debian/mongoexport.1 b/debian/mongoexport.1 index e74a5124d4b..80decfae323 100644 --- a/debian/mongoexport.1 +++ b/debian/mongoexport.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOEXPORT" "1" "January 30, 2015" "3.0" "mongodb-manual" +.TH "MONGOEXPORT" "1" "Jun 21, 2018" "4.0" "mongodb-manual" .SH NAME mongoexport \- MongoDB Export Utility . @@ -30,30 +30,142 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. +.SS On this page +.INDENT 0.0 +.IP \(bu 2 +\fI\%Synopsis\fP +.IP \(bu 2 +\fI\%Considerations\fP +.IP \(bu 2 +\fI\%Required Access\fP +.IP \(bu 2 +\fI\%Read Preference\fP +.IP \(bu 2 +\fI\%Options\fP +.IP \(bu 2 +\fI\%Use\fP +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 +.IP "Mac OSX Sierra and Go 1.6 Incompatibility" +.sp +Users running on Mac OSX Sierra require the 3.2.10 or newer version +of mongoexport\&. +.UNINDENT +.UNINDENT .SH SYNOPSIS .sp -\fBmongoexport\fP is a utility that produces a JSON or CSV export -of data stored in a MongoDB instance. See the -http://docs.mongodb.org/manual/core/import\-export document for a more in depth -usage overview, and the \fBmongoimport\fP document for more +\fI\%mongoexport\fP is a utility that produces a JSON or CSV export +of data stored in a MongoDB instance. +.sp +See the mongoimport document for more information regarding the \fBmongoimport\fP utility, which -provides the inverse "importing" capability. +provides the inverse “importing” capability. +.sp +Run \fI\%mongoexport\fP from the system command line, not the \fBmongo\fP shell. .SH CONSIDERATIONS .sp -Do not use \fBmongoimport\fP and \fBmongoexport\fP for -full\-scale production backups because they may not reliably capture -data type information. Use \fBmongodump\fP and -\fBmongorestore\fP as described in http://docs.mongodb.org/manual/core/backups for this +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +Avoid using \fBmongoimport\fP and \fI\%mongoexport\fP for +full instance production backups. They do not reliably preserve all rich +BSON data types, because JSON can only represent a subset +of the types supported by BSON. Use \fBmongodump\fP +and \fBmongorestore\fP as described in /core/backups for this kind of functionality. +.UNINDENT +.UNINDENT +.sp +\fI\%mongoexport\fP must be run directly from the system command line. +.sp +To preserve type information, \fI\%mongoexport\fP and \fBmongoimport\fP +uses the strict mode representation +for certain types. +.sp +For example, the following insert operation in the \fBmongo\fP +shell uses the shell mode representation for the BSON types +\fBdata_date\fP and \fBdata_numberlong\fP: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +use test +db.traffic.insert( { _id: 1, volume: NumberLong(\(aq2980000\(aq), date: new Date() } ) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +The argument to \fBdata_numberlong\fP must be quoted to avoid potential +loss of accuracy. +.sp +Use \fI\%mongoexport\fP to export the data: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +mongoexport \-\-db test \-\-collection traffic \-\-out traffic.json +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +The exported data is in strict mode representation to preserve type information: +.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 +See /reference/mongodb\-extended\-json for a complete list of +these types and the representations used. +.SH REQUIRED ACCESS +.sp +\fI\%mongoexport\fP requires read access on the target database. +.sp +Ensure that the connecting user possesses, at a minimum, the \fBread\fP +role on the target database. +.sp +When connecting to a \fBmongod\fP or \fBmongos\fP that enforces +/core/authentication, ensure you use the required security +parameters based on the configured +authentication mechanism\&. +.SH READ PREFERENCE +.sp +\fI\%mongoexport\fP defaults to \fBprimary\fP read +preference when connected to a \fBmongos\fP +or a replica set\&. +.sp +You can override the default read preference using the +\fI\%\-\-readPreference\fP option. +.sp +\fBIMPORTANT:\fP +.INDENT 0.0 +.INDENT 3.5 +Using a non\-primary read preference on a \fBmongos\fP may +produce inconsistencies in data, including duplicates or missing +documents. +.UNINDENT +.UNINDENT .SH OPTIONS .sp -Changed in version 3.0.0: \fBmongoexport\fP removed the \fB\-\-dbpath\fP as well as related -\fB\-\-directoryperdb\fP and \fB\-\-journal\fP options. You must use -\fBmongoexport\fP while connected to a \fBmongod\fP instance. +Changed in version 3.0.0: \fI\%mongoexport\fP removed the \fB\-\-dbpath\fP as well as related +\fB\-\-directoryperdb\fP and \fB\-\-journal\fP options. To use +\fI\%mongoexport\fP, you must run \fI\%mongoexport\fP against a running +\fBmongod\fP or \fBmongos\fP instance as appropriate. .sp -Changed in version 3.0.0: \fBmongoexport\fP also removed support for writing data to -\fBtsv\fP files with the \fB\-\-tsv\fP option. +Changed in version 3.0.0: \fI\%mongoexport\fP removed the \fB\-\-csv\fP option. Use the +\fI\%\-\-type=csv\fP option to specify CSV format +for the output. .INDENT 0.0 .TP @@ -61,10 +173,6 @@ Changed in version 3.0.0: \fBmongoexport\fP also removed support for writing dat .UNINDENT .INDENT 0.0 .TP -.B mongoexport -.UNINDENT -.INDENT 0.0 -.TP .B \-\-help Returns information on the options and use of \fBmongoexport\fP\&. .UNINDENT @@ -78,13 +186,13 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs the \fBmongoexport\fP in a quiet mode that attempts to limit the amount +Runs \fBmongoexport\fP in a quiet mode that attempts to limit the amount of output. .sp This option suppresses: .INDENT 7.0 .IP \(bu 2 -output from \fIdatabase commands\fP +output from database commands .IP \(bu 2 replication activity .IP \(bu 2 @@ -100,6 +208,60 @@ Returns the \fBmongoexport\fP release number. .UNINDENT .INDENT 0.0 .TP +.B \-\-uri <connectionString> +New in version 3.4.6. + +.sp +Specify a resolvable URI +connection string for the \fBmongod\fP to which to +connect. +.sp +The following is the standard +URI connection scheme: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +For detailed explanations of the components of this string, refer to +the +Connection String URI Format +documentation. +.sp +\fBIMPORTANT:\fP +.INDENT 7.0 +.INDENT 3.5 +The following \fI\%mongoexport\fP options are incompatible with the +\fB\-\-uri\fP option. Instead, specify these options as part of your +\fB\-\-uri\fP connection string when applicable: +.INDENT 0.0 +.IP \(bu 2 +\fB\-\-host\fP +.IP \(bu 2 +\fB\-\-port\fP +.IP \(bu 2 +\fB\-\-db\fP +.IP \(bu 2 +\fB\-\-username\fP +.IP \(bu 2 +\fB\-\-password\fP (when specifying the password as part of the +URI connection string) +.IP \(bu 2 +\fB\-\-authenticationDatabase\fP +.IP \(bu 2 +\fB\-\-authenticationMechanism\fP +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP .B \-\-host <hostname><:port>, \-h <hostname><:port> \fIDefault\fP: localhost:27017 .sp @@ -140,9 +302,12 @@ client connections. .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support and allows the \fBmongoexport\fP to connect to the -MongoDB instance using an IPv6 network. All MongoDB programs and -processes disable IPv6 support by default. +\fIRemoved in version 3.0.\fP +.sp +Enables IPv6 support and allows \fBmongoexport\fP to connect to the +MongoDB instance using an IPv6 network. Prior to MongoDB 3.0, you +had to specify \fI\%\-\-ipv6\fP to use IPv6. In MongoDB 3.0 and later, IPv6 +is always enabled. .UNINDENT .INDENT 0.0 .TP @@ -151,10 +316,11 @@ New in version 2.6. .sp Enables connection to a \fBmongod\fP or \fBmongos\fP that has -SSL support enabled. +TLS/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\&. +For more information about TLS/SSL and MongoDB, see +/tutorial/configure\-ssl and +/tutorial/configure\-ssl\-clients . .UNINDENT .INDENT 0.0 .TP @@ -166,23 +332,32 @@ 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\&. +Starting in version 3.4, if \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP is not +specified and you are not using x.509 authentication, the +system\-wide CA certificate store will be used when connecting to an +TLS/SSL\-enabled server. +.sp +If using x.509 authentication, \fB\-\-sslCAFile\fP or \fBssl.CAFile\fP +must be specified. .sp \fBWARNING:\fP .INDENT 7.0 .INDENT 3.5 -If the \fBmongo\fP shell or any other tool that connects to -\fBmongos\fP or \fBmongod\fP is run without -\fI\-\-sslCAFile\fP, it will not attempt to validate -server certificates. This results in vulnerability to expired -\fBmongod\fP and \fBmongos\fP certificates as well as to foreign -processes posing as valid \fBmongod\fP or \fBmongos\fP -instances. Ensure that you \fIalways\fP specify the CA file against which -server certificates should be validated in cases where intrusion is a -possibility. +\fBVersion 3.2 and earlier:\fP For TLS/SSL connections (\fB\-\-ssl\fP) to +\fBmongod\fP and \fBmongos\fP, if the \fBmongoexport\fP runs without the +\fI\%\-\-sslCAFile\fP, \fBmongoexport\fP will not attempt +to validate the server certificates. This creates a vulnerability +to expired \fBmongod\fP and \fBmongos\fP certificates as +well as to foreign processes posing as valid \fBmongod\fP or +\fBmongos\fP instances. Ensure that you \fIalways\fP specify the +CA file to validate the server certificates in cases where +intrusion is a possibility. .UNINDENT .UNINDENT +.sp +For more information about TLS/SSL and MongoDB, see +/tutorial/configure\-ssl and +/tutorial/configure\-ssl\-clients . .UNINDENT .INDENT 0.0 .TP @@ -190,17 +365,18 @@ possibility. New in version 2.6. .sp -Specifies the \fB\&.pem\fP file that contains both the SSL certificate +Specifies the \fB\&.pem\fP file that contains both the TLS/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 +This option is required when using the \fI\%\-\-ssl\fP option to connect to a \fBmongod\fP or \fBmongos\fP that has \fBCAFile\fP enabled \fIwithout\fP \fBallowConnectionsWithoutCertificates\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\&. +For more information about TLS/SSL and MongoDB, see +/tutorial/configure\-ssl and +/tutorial/configure\-ssl\-clients . .UNINDENT .INDENT 0.0 .TP @@ -209,16 +385,17 @@ New in version 2.6. .sp Specifies the password to de\-crypt the certificate\-key file (i.e. -\fI\-\-sslPEMKeyFile\fP). Use the \fI\-\-sslPEMKeyPassword\fP option only if the +\fI\%\-\-sslPEMKeyFile\fP). Use the \fI\%\-\-sslPEMKeyPassword\fP option only if the certificate\-key file is encrypted. In all cases, the \fBmongoexport\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 -the \fI\-\-sslPEMKeyPassword\fP option, the \fBmongoexport\fP will prompt for a passphrase. See -\fIssl\-certificate\-password\fP\&. +the \fI\%\-\-sslPEMKeyPassword\fP option, the \fBmongoexport\fP will prompt for a passphrase. See +ssl\-certificate\-password\&. .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\&. +For more information about TLS/SSL and MongoDB, see +/tutorial/configure\-ssl and +/tutorial/configure\-ssl\-clients . .UNINDENT .INDENT 0.0 .TP @@ -230,8 +407,9 @@ 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\&. +For more information about TLS/SSL and MongoDB, see +/tutorial/configure\-ssl and +/tutorial/configure\-ssl\-clients . .UNINDENT .INDENT 0.0 .TP @@ -244,8 +422,36 @@ the use of invalid certificates. When using the \fBallowInvalidCertificates\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\&. +Starting in MongoDB 4.0, if you specify +\fB\-\-sslAllowInvalidCertificates\fP or \fBssl.allowInvalidCertificates: +true\fP when using x.509 authentication, an invalid certificate is +only sufficient to establish a TLS/SSL connection but is +\fIinsufficient\fP for authentication. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +For TLS/SSL connections to \fBmongod\fP and +\fBmongos\fP, avoid using +\fB\-\-sslAllowInvalidCertificates\fP if possible and only use +\fB\-\-sslAllowInvalidCertificates\fP on systems where intrusion is +not possible. +.sp +If the \fBmongo\fP shell (and other +mongodb\-tools\-support\-ssl) runs with the +\fB\-\-sslAllowInvalidCertificates\fP option, the +\fBmongo\fP shell (and other +mongodb\-tools\-support\-ssl) will not attempt to validate +the server certificates. This creates a vulnerability to expired +\fBmongod\fP and \fBmongos\fP certificates as +well as to foreign processes posing as valid +\fBmongod\fP or \fBmongos\fP instances. +.UNINDENT +.UNINDENT +.sp +For more information about TLS/SSL and MongoDB, see +/tutorial/configure\-ssl and +/tutorial/configure\-ssl\-clients . .UNINDENT .INDENT 0.0 .TP @@ -253,9 +459,13 @@ For more information on MongoDB and SSL, see http://docs.mongodb.org/manual/tuto New in version 3.0. .sp -Disables the validation of the hostnames in SSL certificates. Allows -\fBmongoexport\fP to connect to MongoDB instances if the hostname their +Disables the validation of the hostnames in TLS/SSL certificates. Allows +\fBmongoexport\fP to connect to MongoDB instances even if the hostname in their certificates do not match the specified hostname. +.sp +For more information about TLS/SSL and MongoDB, see +/tutorial/configure\-ssl and +/tutorial/configure\-ssl\-clients . .UNINDENT .INDENT 0.0 .TP @@ -265,14 +475,14 @@ New in version 2.6. .sp Directs the \fBmongoexport\fP to use the FIPS mode of the installed OpenSSL library. Your system must have a FIPS compliant OpenSSL library to use -the \fI\-\-sslFIPSMode\fP option. +the \fI\%\-\-sslFIPSMode\fP option. .sp \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -FIPS Compatible SSL is +FIPS\-compatible TLS/SSL is available only in \fI\%MongoDB Enterprise\fP\&. See -http://docs.mongodb.org/manual/tutorial/configure\-fips for more information. +/tutorial/configure\-fips for more information. .UNINDENT .UNINDENT .UNINDENT @@ -290,29 +500,39 @@ 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. .sp -If you do not specify an argument for \fI\-\-password\fP, \fBmongoexport\fP will -prompt interactively for a password on the console. +Changed in version 3.0.0: If you do not specify an argument for \fI\%\-\-password\fP, \fBmongoexport\fP returns +an error. + +.sp +Changed in version 3.0.2: If you wish \fBmongoexport\fP to prompt the user +for the password, pass the \fI\%\-\-username\fP option without +\fI\%\-\-password\fP or specify an empty string as the \fI\%\-\-password\fP value, +as in \fB\-\-password ""\fP . + .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationDatabase <dbname> +Specifies the database in which the user is created. +See user\-authentication\-database\&. +.sp If you do not specify an authentication database, \fBmongoexport\fP -assumes that the database specified to export holds the user\(aqs credentials. +assumes that the database specified to export holds the user’s credentials. .UNINDENT .INDENT 0.0 .TP .B \-\-authenticationMechanism <name> -\fIDefault\fP: MONGODB\-CR -.sp -New in version 2.4. - -.sp -Changed in version 2.6: Added support for the \fBPLAIN\fP and \fBMONGODB\-X509\fP authentication -mechanisms. - +\fIDefault\fP: SCRAM\-SHA\-1 .sp Specifies the authentication mechanism the \fBmongoexport\fP instance uses to authenticate to the \fBmongod\fP or \fBmongos\fP\&. +.sp +Changed in version 4.0: MongoDB removes support for the deprecated MongoDB +Challenge\-Response (\fBMONGODB\-CR\fP) authentication mechanism. +.sp +MongoDB adds support for SCRAM mechanism using the SHA\-256 hash +function (\fBSCRAM\-SHA\-256\fP). + .TS center; |l|l|. @@ -324,33 +544,47 @@ Description T} _ T{ -MONGODB\-CR +SCRAM\-SHA\-1 T} T{ -MongoDB challenge/response authentication. +\fI\%RFC 5802\fP standard +Salted Challenge Response Authentication Mechanism using the SHA\-1 +hash function. T} _ T{ -MONGODB\-X509 +SCRAM\-SHA\-256 T} T{ -MongoDB SSL certificate authentication. +\fI\%RFC 7677\fP standard +Salted Challenge Response Authentication Mechanism using the SHA\-256 +hash function. +.sp +Requires featureCompatibilityVersion set to \fB4.0\fP\&. +.sp +New in version 4.0. T} _ T{ -PLAIN +MONGODB\-X509 T} T{ -External authentication using LDAP. You can also use \fBPLAIN\fP -for authenticating in\-database users. \fBPLAIN\fP transmits -passwords in plain text. This mechanism is available only in -\fI\%MongoDB Enterprise\fP\&. +MongoDB TLS/SSL certificate authentication. T} _ T{ -GSSAPI +GSSAPI (Kerberos) T} T{ External authentication using Kerberos. This mechanism is available only in \fI\%MongoDB Enterprise\fP\&. T} _ +T{ +PLAIN (LDAP SASL) +T} T{ +External authentication using LDAP. You can also use \fBPLAIN\fP +for authenticating in\-database users. \fBPLAIN\fP transmits +passwords in plain text. This mechanism is available only in +\fI\%MongoDB Enterprise\fP\&. +T} +_ .TE .UNINDENT .INDENT 0.0 @@ -359,7 +593,7 @@ _ New in version 2.6. .sp -Specify the name of the service using \fBGSSAPI/Kerberos\fP\&. Only required if the service does not use the +Specify the name of the service using GSSAPI/Kerberos\&. Only required if the service does not use the default name of \fBmongodb\fP\&. .sp This option is available only in MongoDB Enterprise. @@ -370,7 +604,7 @@ This option is available only in MongoDB Enterprise. New in version 2.6. .sp -Specify the hostname of a service using \fBGSSAPI/Kerberos\fP\&. \fIOnly\fP required if the hostname of a machine does +Specify the hostname of a service using GSSAPI/Kerberos\&. \fIOnly\fP required if the hostname of a machine does not match the hostname resolved by DNS. .sp This option is available only in MongoDB Enterprise. @@ -391,36 +625,48 @@ Specifies the collection to export. Specifies a field or fields to \fIinclude\fP in the export. Use a comma separated list of fields to specify multiple fields. .sp -For \fIcsv\fP output formats, -\fBmongoexport\fP includes only the specified field(s), and the +If any of your field names include white space, use +quotation marks to enclose the field list. For example, if you wished +to export two fields, \fBphone\fP and \fBuser number\fP, you would +specify \fB\-\-fields "phone,user number"\fP\&. +.sp +For \fI\%csv\fP output formats, +\fI\%mongoexport\fP includes only the specified field(s), and the specified field(s) can be a field within a sub\-document. .sp -For \fIJSON\fP output formats, \fBmongoexport\fP includes +For JSON output formats, \fI\%mongoexport\fP includes only the specified field(s) \fBand\fP the \fB_id\fP field, and if the specified field(s) is a field within a sub\-document, the -\fBmongoexport\fP includes the sub\-document with all +\fI\%mongoexport\fP includes the sub\-document with all its fields, not just the specified field within the document. +.sp +See: \fI\%Export Data in CSV Format using \-\-fields option\fP for sample usage. .UNINDENT .INDENT 0.0 .TP .B \-\-fieldFile <filename> -An alternative to \fI\-\-fields\fP\&. The -\fI\-\-fieldFile\fP option allows you to +An alternative to \fI\%\-\-fields\fP\&. The +\fI\%\-\-fieldFile\fP option allows you to specify in a file the field or fields to \fIinclude\fP in the export and is -\fBonly valid\fP with the \fI\-\-type\fP option +\fBonly valid\fP with the \fI\%\-\-type\fP option with value \fBcsv\fP\&. The file must have only one field per line, and the line(s) must end with the LF character (\fB0x0A\fP). .sp -\fBmongoexport\fP includes only the specified field(s). The +\fI\%mongoexport\fP includes only the specified field(s). The specified field(s) can be a field within a sub\-document. +.sp +See \fI\%Use a File to Specify the Fields to Export in CSV Format\fP for sample usage. .UNINDENT .INDENT 0.0 .TP .B \-\-query <JSON>, \-q <JSON> -Provides a \fIJSON document\fP as a query that optionally limits -the documents returned in the export. Specify JSON in \fBstrict -format\fP\&. +Provides a JSON document as a query that optionally limits +the documents returned in the export. Specify JSON in strict +format\&. +.sp +You must enclose the query in single quotes (e.g. \fB\(aq\fP) to ensure that it does +not interact with your shell environment. .sp For example, given a collection named \fBrecords\fP in the database \fBtest\fP with the following documents: @@ -439,7 +685,7 @@ For example, given a collection named \fBrecords\fP in the database .UNINDENT .UNINDENT .sp -The following \fBmongoexport\fP uses the \fI\%\-q\fP option to +The following \fI\%mongoexport\fP uses the \fI\%\-q\fP option to export only the documents with the field \fBa\fP greater than or equal to (\fB$gte\fP) to \fB3\fP: .INDENT 7.0 @@ -447,7 +693,7 @@ export only the documents with the field \fBa\fP greater than or equal to .sp .nf .ft C -mongoexport \-d test \-c records \-q "{ a: { \e$gte: 3 } }" \-\-out exportdir/myRecords.json +mongoexport \-d test \-c records \-q \(aq{ a: { $gte: 3 } }\(aq \-\-out exportdir/myRecords.json .ft P .fi .UNINDENT @@ -467,36 +713,36 @@ The resulting file contains the following documents: .UNINDENT .sp You can sort the results with the \fI\%\-\-sort\fP option to -\fBmongoexport\fP\&. +\fI\%mongoexport\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-type <string> \fIDefault\fP: json .sp -New in version 3.0.0. +New in version 3.0. .sp -Specifies the file type to export. The default format is \fIJSON\fP, -bit it is possible to export \fIcsv\fP files. +Specifies the file type to export. Specify \fBcsv\fP for CSV +format or \fBjson\fP for JSON format. .sp If you specify \fBcsv\fP, then you must also use either -the \fI\-\-fields\fP or the \fI\-\-fieldFile\fP option to +the \fI\%\-\-fields\fP or the \fI\%\-\-fieldFile\fP option to declare the fields to export from the collection. .UNINDENT .INDENT 0.0 .TP .B \-\-out <file>, \-o <file> Specifies a file to write the export to. If you do not specify a file -name, the \fBmongoexport\fP writes data to standard output +name, the \fI\%mongoexport\fP writes data to standard output (e.g. \fBstdout\fP). .UNINDENT .INDENT 0.0 .TP .B \-\-jsonArray -Modifies the output of \fBmongoexport\fP to write the -entire contents of the export as a single \fIJSON\fP array. By -default \fBmongoexport\fP writes data using one JSON document +Modifies the output of \fI\%mongoexport\fP to write the +entire contents of the export as a single JSON array. By +default \fI\%mongoexport\fP writes data using one JSON document for every MongoDB document. .UNINDENT .INDENT 0.0 @@ -509,26 +755,70 @@ Outputs documents in a pretty\-printed format JSON. .UNINDENT .INDENT 0.0 .TP -.B \-\-slaveOk, \-k -Allows \fBmongoexport\fP to read data from secondary or slave -nodes when using \fBmongoexport\fP with a replica set. This -option is only available if connected to a \fBmongod\fP or -\fBmongos\fP and is not available when used with the -"\fImongoexport \-\-dbpath\fP" option. +.B \-\-noHeaderLine +New in version 3.4. + +.sp +By default, \fBmongoexport\fP includes the exported field names as the first +line in a CSV output. \fI\%\-\-noHeaderLine\fP directs \fBmongoexport\fP to export the +data without the list of field names. +\fI\%\-\-noHeaderLine\fP is \fBonly valid\fP with the +\fI\%\-\-type\fP option with value \fBcsv\fP\&. .sp -This is the default behavior. +See \fI\%Exclude Field Names from CSV Output\fP for sample usage. .UNINDENT .INDENT 0.0 .TP -.B \-\-forceTableScan -New in version 2.2. +.B \-\-slaveOk, \-k +Deprecated since version 3.2. .sp -Forces \fBmongoexport\fP to scan the data store directly: -typically, \fBmongoexport\fP saves entries as they appear in the -index of the \fB_id\fP field. Use \fI\%\-\-forceTableScan\fP to skip -the index and scan the data directly. Typically there are two cases -where this behavior is preferable to the default: +Sets the replica\-set\-read\-preference to \fBnearest\fP, +allowing \fI\%mongoexport\fP to read data from secondary +replica set members. +.sp +\fI\%\-\-readPreference\fP replaces \fB\-\-slaveOk\fP in MongoDB 3.2. You cannot +specify \fB\-\-slaveOk\fP when \fI\%\-\-readPreference\fP is specified. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Using a read preference other than +\fBprimary\fP with a connection to a \fBmongos\fP may produce +inconsistencies, duplicates, or result in missed documents. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-readPreference <string> +Specify the read preference for +\fBmongoexport\fP\&. +.sp +See replica\-set\-read\-preference\-modes\&. +.sp +\fBmongoexport\fP defaults to \fBprimary\fP +read preference when connected to a +\fBmongos\fP or a replica set\&. +.sp +Otherwise, \fBmongoexport\fP defaults to \fBnearest\fP\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Using a read preference other than +\fBprimary\fP with a connection to a \fBmongos\fP may produce +inconsistencies, duplicates, or result in missed documents. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-forceTableScan +Forces \fI\%mongoexport\fP to scan the data store directly instead +of traversing the \fB_id\fP field index. Use \fI\%\-\-forceTableScan\fP to skip the +index. Typically there are two cases where this behavior is +preferable to the default: .INDENT 7.0 .IP 1. 3 If you have key sizes over 800 bytes that would not be present @@ -537,10 +827,9 @@ in the \fB_id\fP index. Your database uses a custom \fB_id\fP field. .UNINDENT .sp -When you run with \fI\%\-\-forceTableScan\fP, \fBmongoexport\fP -does not use \fB$snapshot\fP\&. As a result, the export produced -by \fBmongoexport\fP can reflect the state of the database at -many different points in time. +When you run with \fI\%\-\-forceTableScan\fP, \fI\%mongoexport\fP may return a +document more than once if a write operation interleaves with the +operation to cause the document to move. .sp \fBWARNING:\fP .INDENT 7.0 @@ -553,7 +842,7 @@ and consideration. .INDENT 0.0 .TP .B \-\-skip <number> -Use \fI\%\-\-skip\fP to control where \fBmongoexport\fP begins +Use \fI\%\-\-skip\fP to control where \fI\%mongoexport\fP begins exporting documents. See \fBskip()\fP for information about the underlying operation. .UNINDENT @@ -592,118 +881,169 @@ operation. .SH USE .SS Export in CSV Format .sp -In the following example, \fBmongoexport\fP exports the -collection \fBcontacts\fP from the \fBusers\fP database from the -\fBmongod\fP instance running on the localhost port number -\fB27017\fP\&. This command writes the export data in \fICSV\fP format -into a file located at \fB/opt/backups/contacts.csv\fP\&. The -\fBfields.txt\fP file contains a line\-separated list of fields to -export. +Changed in version 3.0.0: \fI\%mongoexport\fP removed the \fB\-\-csv\fP option. Use the +\fI\%\-\-type=csv\fP option to specify CSV format +for the output. + +.SS Export Data in CSV Format using \fB\-\-fields\fP option +.sp +In the following example, \fI\%mongoexport\fP exports data from the +collection \fBcontacts\fP collection in the \fBusers\fP database in CSV +format to the file \fB/opt/backups/contacts.csv\fP\&. +.sp +The \fBmongod\fP instance that \fI\%mongoexport\fP connects to is +running on the localhost port number \fB27017\fP\&. +.sp +When you export in CSV format, you must specify the fields in the documents +to export. The operation specifies the \fBname\fP and \fBaddress\fP fields +to export. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -mongoexport \-\-db users \-\-collection contacts \-\-csv \-\-fieldFile fields.txt \-\-out /opt/backups/contacts.csv +mongoexport \-\-db users \-\-collection contacts \-\-type=csv \-\-fields name,address \-\-out /opt/backups/contacts.csv .ft P .fi .UNINDENT .UNINDENT -.SS Export in JSON Format .sp -The next example creates an export of the collection \fBcontacts\fP -from the MongoDB instance running on the localhost port number \fB27017\fP, -with journaling explicitly enabled. This writes the export to the -\fBcontacts.json\fP file in \fIJSON\fP format. +The output would then resemble: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -mongoexport \-\-db sales \-\-collection contacts \-\-out contacts.json \-\-journal +name, address +Sophie Monroe, 123 Example Road +Charles Yu, 345 Sample Street .ft P .fi .UNINDENT .UNINDENT -.SS Export from Remote Host Running with Authentication +.SS Use a File to Specify the Fields to Export in CSV Format +.sp +For CSV exports only, you can also specify the fields in a file +containing the line\-separated list of fields to export. The file must +have only one field per line. .sp -The following example exports the collection \fBcontacts\fP from the -database \fBmarketing\fP . This data resides on the MongoDB instance -located on the host \fBmongodb1.example.net\fP running on port \fB37017\fP, -which requires the username \fBuser\fP and the password \fBpass\fP\&. +For example, you can specify the \fBname\fP and \fBaddress\fP fields in a +file \fBfields.txt\fP: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -mongoexport \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-password pass \-\-collection contacts \-\-db marketing \-\-out mdb1\-examplenet.json +name +address .ft P .fi .UNINDENT .UNINDENT -.SH TYPE FIDELITY .sp -\fBWARNING:\fP +Then, using the \fI\%\-\-fieldFile\fP option, specify the fields to export with +the file: .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 the \fBExtended JSON\fP -reference for more information. +.sp +.nf +.ft C +mongoexport \-\-db users \-\-collection contacts \-\-type=csv \-\-fieldFile fields.txt \-\-out /opt/backups/contacts.csv +.ft P +.fi .UNINDENT .UNINDENT +.SS Exclude Field Names from CSV Output .sp -JSON can only represent a subset of the types supported by BSON. To -preserve type information, \fBmongoexport\fP uses the \fBstrict -mode representation\fP for certain -types. +New in version 3.4. + .sp -For example, the following insert operation in the \fBmongo\fP -shell uses the \fBmongoShell mode representation\fP for the BSON types -\fBdata_date\fP and \fBdata_numberlong\fP: +MongoDB 3.4 added the \fI\%\-\-noHeaderLine\fP option for excluding the +field names in a CSV export. The following example exports the \fBname\fP +and \fBaddress\fP fields in the \fBcontacts\fP collection in the \fBusers\fP +database and uses \fI\%\-\-noHeaderLine\fP to suppress the output +of the field names as the first line: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -use test -db.traffic.insert( { _id: 1, volume: NumberLong(2980000), date: new Date() } ) +mongoexport \-\-db users \-\-collection contacts \-\-type csv \-\-fields name,address \-\-noHeaderLine \-\-out /opt/backups/contacts.csv .ft P .fi .UNINDENT .UNINDENT .sp -Use \fBmongoexport\fP to export the data: +The CSV output would then resemble: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -mongoexport \-\-db test \-\-collection traffic \-\-out traffic.json +Sophie Monroe, 123 Example Road +Charles Yu, 345 Sample Street .ft P .fi .UNINDENT .UNINDENT +.SS Export in JSON Format .sp -The exported data is in \fBstrict mode representation\fP to preserve type information: +This example creates an export of the \fBcontacts\fP collection from the +MongoDB instance running on the localhost port number \fB27017\fP\&. This +writes the export to the \fBcontacts.json\fP file in JSON format. .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -{ "_id" : 1, "volume" : { "$numberLong" : "2980000" }, "date" : { "$date" : "2014\-03\-13T13:47:42.483\-0400" } } +mongoexport \-\-db sales \-\-collection contacts \-\-out contacts.json .ft P .fi .UNINDENT .UNINDENT +.SS Export from Remote Host Running with Authentication .sp -See http://docs.mongodb.org/manual/reference/mongodb\-extended\-json for a complete list of -these types and the representations used. +The following example exports the \fBcontacts\fP collection from the +\fBmarketing\fP database, which requires authentication. +.sp +This data resides on the MongoDB instance located on the host +\fBmongodb1.example.net\fP running on port \fB37017\fP, which requires the username +\fBuser\fP and the password \fBpass\fP\&. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +mongoexport \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-password "pass" \-\-collection contacts \-\-db marketing \-\-out mdb1\-examplenet.json +.ft P +.fi +.UNINDENT +.UNINDENT +.SS Export Query Results +.sp +You can export only the results of a query by supplying a query filter with +the \fI\%\-\-query\fP option, and limit the results to a single +database using the “\fI\%\-\-db\fP” option. +.sp +For instance, this command returns all documents in the \fBsales\fP database’s +\fBcontacts\fP collection that contain a field named \fBfield\fP with a value +of \fB1\fP\&. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +mongoexport \-\-db sales \-\-collection contacts \-\-query \(aq{"field": 1}\(aq +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +You must enclose the query in single quotes (e.g. \fB\(aq\fP) to ensure that it does +not interact with your shell environment. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2015 +2008-2018 .\" Generated by docutils manpage writer. . |