diff options
Diffstat (limited to 'debian')
| -rw-r--r-- | debian/bsondump.1 | 65 | ||||
| -rw-r--r-- | debian/mongo.1 | 401 | ||||
| -rw-r--r-- | debian/mongod.1 | 1479 | ||||
| -rw-r--r-- | debian/mongodump.1 | 549 | ||||
| -rw-r--r-- | debian/mongoexport.1 | 448 | ||||
| -rw-r--r-- | debian/mongofiles.1 | 268 | ||||
| -rw-r--r-- | debian/mongoimport.1 | 379 | ||||
| -rw-r--r-- | debian/mongooplog.1 | 303 | ||||
| -rw-r--r-- | debian/mongoperf.1 | 12 | ||||
| -rw-r--r-- | debian/mongorestore.1 | 414 | ||||
| -rw-r--r-- | debian/mongos.1 | 898 | ||||
| -rw-r--r-- | debian/mongosniff.1 | 48 | ||||
| -rw-r--r-- | debian/mongostat.1 | 241 | ||||
| -rw-r--r-- | debian/mongotop.1 | 234 |
14 files changed, 3539 insertions, 2200 deletions
diff --git a/debian/bsondump.1 b/debian/bsondump.1 index 5aec65755da..f91b910787e 100644 --- a/debian/bsondump.1 +++ b/debian/bsondump.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "BSONDUMP" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "BSONDUMP" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -bsondump \- MongoDB BSON utility +bsondump \- MongoDB BSON Utility . .nr rst2man-indent-level 0 . @@ -54,30 +54,45 @@ BSON files, not a tool for data ingestion or other application use. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBbsondump\fP options and usage. .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\&.) +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 \fBbsondump\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 version of the \fBbsondump\fP utility. +Returns the \fBbsondump\fP release number. .UNINDENT .INDENT 0.0 .TP .B \-\-objcheck -Validates each \fIBSON\fP object before outputting it in -\fIJSON\fP format. By default, \fBbsondump\fP enables -\fI\-\-objcheck\fP\&. For objects with a high degree of -sub\-document nesting, \fI\-\-objcheck\fP can have a small impact -on performance. You can set \fI\-\-noobjcheck\fP to disable -object checking. +Validates each \fIBSON\fP object before outputting it in \fIJSON\fP +format. By default, \fBbsondump\fP enables \fI\-\-objcheck\fP\&. +For objects with a high degree of sub\-document nesting, +\fI\-\-objcheck\fP can have a small impact on performance. You can set +\fI\-\-noobjcheck\fP to disable object checking. .sp Changed in version 2.4: MongoDB enables \fI\-\-objcheck\fP by default, to prevent any client from inserting malformed or invalid BSON into a MongoDB @@ -90,31 +105,31 @@ database. New in version 2.4. .sp -Disables the default document validation that \fBbsondump\fP -performs on all BSON documents. +Disables the default document validation that MongoDB performs on all +incoming BSON documents. .UNINDENT .INDENT 0.0 .TP -.B \-\-filter \(aq<JSON>\(aq +.B \-\-filter <JSON> Limits the documents that \fBbsondump\fP exports to only those documents that match the \fIJSON document\fP specified as -\fB\(aq<JSON>\(aq\fP\&. Be sure to include the document in single quotes to -avoid interaction with your system\(aqs shell environment. +\fB\(aq<JSON>\(aq\fP\&. Be sure to include the document in single quotes to avoid +interaction with your system\(aqs shell environment. .UNINDENT .INDENT 0.0 .TP .B \-\-type <=json|=debug> -Changes the operation of \fBbsondump\fP from outputting "\fIJSON\fP" (the -default) to a debugging format. +Changes the operation of \fBbsondump\fP from outputting +"\fIJSON\fP" (the default) to a debugging format. .UNINDENT .INDENT 0.0 .TP -.B <bsonfilename> +.B <bsonFilename> The final argument to \fBbsondump\fP is a document containing \fIBSON\fP\&. This data is typically generated by -\fBmongodump\fP or by MongoDB in a \fIrollback\fP operation. +\fBbsondump\fP or by MongoDB in a \fIrollback\fP operation. .UNINDENT -.SH USAGE +.SH USE .sp By default, \fBbsondump\fP outputs data to standard output. To create corresponding \fIJSON\fP files, you will need to use the @@ -145,6 +160,6 @@ bsondump \-\-type=debug collection.bson .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongo.1 b/debian/mongo.1 index daff93bb7c8..87523a98768 100644 --- a/debian/mongo.1 +++ b/debian/mongo.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGO" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGO" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME mongo \- MongoDB Shell . @@ -39,8 +39,8 @@ operations directly with the database. \fBmongo\fP also provides a fully functional JavaScript environment for use with a MongoDB. This document addresses the basic invocation of the \fBmongo\fP shell and an overview of its usage. -.SH INTERFACE -.SS Options +.SH OPTIONS +.SS Core Options .INDENT 0.0 .TP .B mongo @@ -48,25 +48,23 @@ and an overview of its usage. .INDENT 0.0 .TP .B \-\-shell -Enables the shell interface after evaluating a \fIJavaScript\fP file. -If you invoke the \fBmongo\fP command and specify a JavaScript -file as an argument, or use \fI\%--eval\fP to specify -JavaScript on the command line, the \fI\%--shell\fP option -provides the user with a shell prompt after the file finishes -executing. +Enables the shell interface. If you invoke the \fBmongo\fP command +and specify a JavaScript file as an argument, or use \fI\%\-\-eval\fP to +specify JavaScript on the command line, the \fI\%\-\-shell\fP option +provides the user with a shell prompt after the file finishes executing. .UNINDENT .INDENT 0.0 .TP .B \-\-nodb -Prevents the shell from connecting to any database instances. Later, -to connect to a database within the shell, see +Prevents the shell from connecting to any database instances. Later, to +connect to a database within the shell, see \fImongo\-shell\-new\-connections\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-norc -Prevents the shell from sourcing and evaluating -\fB~/.mongorc.js\fP on start up. +Prevents the shell from sourcing and evaluating \fB~/.mongorc.js\fP on +start up. .UNINDENT .INDENT 0.0 .TP @@ -77,177 +75,60 @@ Silences output from the shell during the connection process. .TP .B \-\-port <port> Specifies the port where the \fBmongod\fP or \fBmongos\fP -instance is listening. Unless specified \fBmongo\fP connects -to \fBmongod\fP instances on port \fB27017\fP, which is the default -\fBmongod\fP port. +instance is listening. If \fI\-\-port\fP is not specified, +\fBmongo\fP attempts to connect to port \fB27017\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-host <hostname> -specifies the host where the \fBmongod\fP or \fBmongos\fP is running to -connect to as \fB<hostname>\fP\&. By default \fBmongo\fP will attempt -to connect to a MongoDB process running on the localhost. +Specifies the name of the host machine where the \fBmongod\fP or +\fBmongos\fP is running. If this is not specified, +\fBmongo\fP attempts to connect to a MongoDB process running on +the localhost. .UNINDENT .INDENT 0.0 .TP .B \-\-eval <javascript> -Evaluates a JavaScript expression specified as an argument to this -option. \fBmongo\fP does not load its own environment when evaluating -code: as a result many options of the shell environment are not -available. +Evaluates a JavaScript expression that is specified as an argument. +\fBmongo\fP does not load its own environment when evaluating code. +As a result many options of the shell environment are not available. .UNINDENT .INDENT 0.0 .TP -.B \-\-username <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance. -Use in conjunction with the -\fI\-\-password\fP option to supply a password. -If you specify a username and password but the default database -or the specified database do not require authentication, -\fBmongo\fP will exit with an exception. +.B \-\-username <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 <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. -Use in conjunction with the -\fI\-\-username\fP option to supply a username. If you -specify a \fI\-\-username\fP and do not pass an argument to the -\fI\-\-password\fP option, \fBmongo\fP will prompt for a -password interactively, if the \fBmongod\fP or -\fBmongos\fP requires authentication. -.sp -If you chose not to provide an argument so that \fBmongo\fP -will prompt for a password, \fI\-\-password\fP must be the last -option. -.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, \fBmongo\fP assumes that the database name specified -in the \fI\%db address\fP holds the user\(aqs -credentials, unless you specify \fI\-\-authenticationDatabase\fP\&. -.sp -See \fBuserSource\fP, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges 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 MongoDB Enterprise, -\fBmongo\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. -.sp -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 \-\-ssl -Enable connection to a \fBmongod\fP or -\fBmongos\fP that has SSL encryption. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyFile <filename> -New in version 2.4. - -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. -.UNINDENT -.UNINDENT -.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 -Required when using the \fI\-\-ssl\fP option if the -\fBmongod\fP or \fBmongos\fP has \fBsslCAFile\fP -enabled \fIwithout\fP \fBsslWeakCertificateValidation\fP\&. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslPEMKeyPassword <value> -New in version 2.4. - -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. -.UNINDENT -.UNINDENT -.sp -Specifies the password to decrypt the root certificate chain -specified by \fI\-\-sslPEMKeyFile\fP\&. -.sp -Only required if the certificate\-key file is encrypted. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-sslCAFile <filename> -New in version 2.4. - -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. -.UNINDENT -.UNINDENT -.sp -Specifies the \fB\&.pem\fP file that contains the certificate from -the Certificate Authority. Specify the file name of the \fB\&.pem\fP -file using relative or absolute paths +.B \-\-password <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 \-\-help, \-h -Returns a basic help and usage text. +Returns information on \fBmongo\fP options and usage. .UNINDENT .INDENT 0.0 .TP .B \-\-version -Returns the version of the shell. +Returns the \fBmongo\fP release number. .UNINDENT .INDENT 0.0 .TP .B \-\-verbose -Increases the verbosity of the output of the shell during the -connection process. +Increases the verbosity of the output of the shell during the connection +process. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support that allows \fBmongo\fP to connect -to the MongoDB instance using an IPv6 network. All MongoDB programs -and processes, including \fBmongo\fP, disable IPv6 -support by default. +Enables IPv6 support, which allows \fBmongo\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongo\fP, disable IPv6 support by default. .UNINDENT .INDENT 0.0 .TP @@ -266,10 +147,10 @@ mongo admin .UNINDENT .sp The above command will connect the \fBmongo\fP shell to the -\fIadmin database\fP on the local machine. You may specify a -remote database instance, with the resolvable hostname or IP -address. Separate the database name from the hostname using a -\fB/\fP character. See the following examples: +\fIadmin database\fP on the local machine. You may specify a remote +database instance, with the resolvable hostname or IP address. Separate +the database name from the hostname using a \fB/\fP character. See the +following examples: .INDENT 7.0 .INDENT 3.5 .sp @@ -286,17 +167,17 @@ mongo 10.8.8.10/test .INDENT 0.0 .TP .B <file.js> -Specifies a JavaScript file to run and then exit. -Generally this should be the last option specified. +Specifies a JavaScript file to run and then exit. Generally this should +be the last option specified. .INDENT 7.0 .INDENT 3.5 .SS Optional .sp To specify a JavaScript file to execute \fIand\fP allow \fBmongo\fP to prompt you for a password using -\fI\-\-password\fP, pass the filename as the first parameter -with \fI\-\-username\fP and \fI\-\-password\fP s the last -options as in the following: +\fI\-\-password\fP, pass the filename as the first parameter with +\fI\-\-username\fP and \fI\-\-password\fP as the last options, as +in the following: .INDENT 0.0 .INDENT 3.5 .sp @@ -310,19 +191,145 @@ mongo file.js \-\-username username \-\-password .UNINDENT .UNINDENT .sp -Use the \fI\%--shell\fP option to return to a shell after the -file finishes running. +Use the \fI\%\-\-shell\fP option to return to a shell after the file +finishes running. .UNINDENT -.SS Files +.SS Authentication Options +.INDENT 0.0 +.TP +.B \-\-authenticationDatabase <dbname> +New in version 2.4. + .sp -\fB~/.dbshell\fP +Specifies the database that holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongo\fP assumes +that the database specified as the argument to the \fI\-\-db\fP option +holds the user\(aqs credentials. +.UNINDENT .INDENT 0.0 -.INDENT 3.5 +.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 MongoDB Enterprise, \fBmongo\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 +.SS SSL Options +.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 \-\-sslPEMKeyFile <filename> +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 <value> +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, \fBmongo\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, \fBmongo\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 \-\-sslCAFile <filename> +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 \-\-sslCRLFile <filename> +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 \-\-sslFIPSMode +New in version 2.6. + +.sp +Directs \fBmongo\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 \-\-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 +.SH FILES +.INDENT 0.0 +.TP +.B \fB~/.dbshell\fP \fBmongo\fP maintains a history of commands in the \fB\&.dbshell\fP file. .sp \fBNOTE:\fP -.INDENT 0.0 +.INDENT 7.0 .INDENT 3.5 \fBmongo\fP does not recorded interaction related to authentication in the history file, including @@ -331,7 +338,7 @@ authentication in the history file, including .UNINDENT .sp \fBWARNING:\fP -.INDENT 0.0 +.INDENT 7.0 .INDENT 3.5 Versions of Windows \fBmongo.exe\fP earlier than 2.2.0 will save the \fI\&.dbshell\fP file in the \fBmongo.exe\fP working @@ -339,45 +346,49 @@ directory. .UNINDENT .UNINDENT .UNINDENT -.UNINDENT -.sp -\fB~/.mongorc.js\fP .INDENT 0.0 -.INDENT 3.5 +.TP +.B \fB~/.mongorc.js\fP \fBmongo\fP will read the \fB\&.mongorc.js\fP file from the home directory of the user invoking \fBmongo\fP\&. In the file, users can define variables, customize the \fBmongo\fP shell prompt, or update information that they would like updated every time they launch a shell. If you use the shell to evaluate a JavaScript file -or expression either on the command line with \fI\%--eval\fP or +or expression either on the command line with \fI\%\-\-eval\fP or by specifying \fI\%a .js file to mongo\fP, \fBmongo\fP will read the \fB\&.mongorc.js\fP file \fIafter\fP the JavaScript has finished processing. .sp -Specify the \fI\%--norc\fP option to disable +Specify the \fI\%\-\-norc\fP option to disable reading \fB\&.mongorc.js\fP\&. .UNINDENT -.UNINDENT -.sp -\fB/tmp/mongo_edit\fI<time_t>\fP\&.js\fP .INDENT 0.0 -.INDENT 3.5 -Created by \fBmongo\fP when editing a file. If the file -exists \fBmongo\fP will append an integer from \fB1\fP to \fB10\fP to the +.TP +.B \fB/etc/mongorc.js\fP +Global \fBmongorc.js\fP file which the \fBmongo\fP shell +evaluates upon start\-up. If a user also has a \fB\&.mongorc.js\fP +file located in the \fI\%HOME\fP directory, the \fBmongo\fP +shell evaluates the global \fB/etc/mongorc.js\fP file \fIbefore\fP +evaluating the user\(aqs \fB\&.mongorc.js\fP file. +.sp +\fB/etc/mongorc.js\fP must have read permission for the user +running the shell. The \fI\%\-\-norc\fP option for \fBmongo\fP +suppresses only the user\(aqs \fB\&.mongorc.js\fP file. +.sp +On Windows, the global \fBmongorc.js </etc/mongorc.js>\fP exists +in the \fB%ProgramData%\eMongoDB\fP directory. +.TP +.B \fB/tmp/mongo_edit\fI<time_t>\fP\&.js\fP +Created by \fBmongo\fP when editing a file. If the file exists, +\fBmongo\fP will append an integer from \fB1\fP to \fB10\fP to the time value to attempt to create a unique file. +.TP +.B \fB%TEMP%mongo_edit\fI<time_t>\fP\&.js\fP +Created by \fBmongo.exe\fP on Windows when editing a file. If +the file exists, \fBmongo\fP will append an integer from \fB1\fP +to \fB10\fP to the time value to attempt to create a unique file. .UNINDENT -.UNINDENT -.sp -\fB%TEMP%mongo_edit\fI<time_t>\fP\&.js\fP -.INDENT 0.0 -.INDENT 3.5 -Created by \fBmongo.exe\fP on Windows when editing a file. -If the file -exists \fBmongo\fP will append an integer from \fB1\fP to \fB10\fP to -the time value to attempt to create a unique file. -.UNINDENT -.UNINDENT -.SS Environment +.SH ENVIRONMENT .INDENT 0.0 .TP .B EDITOR @@ -762,6 +773,6 @@ the additional JavaScript required to generate this output. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongod.1 b/debian/mongod.1 index 285b3c2f8c8..4213ebd171b 100644 --- a/debian/mongod.1 +++ b/debian/mongod.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOD" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOD" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME mongod \- MongoDB Server . @@ -51,124 +51,96 @@ below. .INDENT 0.0 .TP .B \-\-help, \-h -Returns a basic help and usage text. +Returns information on \fBmongod\fP options and usage. .UNINDENT .INDENT 0.0 .TP .B \-\-version -Returns the version of the \fBmongod\fP daemon. +Returns the \fBmongod\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-config <filename>, \-f <filename> -Specifies a configuration file, that you can use to specify -runtime\-configurations. While the options are equivalent and -accessible via the other command line arguments, the configuration -file is the preferred method for runtime configuration of -mongod. See the http://docs.mongodb.org/manual/reference/configuration\-options document -for more information about these options. +.B \-\-config <filename>, \-f +Specifies a configuration file for runtime configuration options. The +configuration file is the preferred method for runtime configuration of +\fBmongod\fP\&. The options are equivalent to the command\-line +configuration options. See http://docs.mongodb.org/manual/reference/configuration\-options for +more information. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Ensure the configuration file uses ASCII -encoding. \fBmongod\fP does not support configuration files -with non\-ASCII encoding, including UTF\-8. -.UNINDENT -.UNINDENT +Ensure the configuration file uses ASCII encoding. \fBmongod\fP does not +support configuration files with non\-ASCII encoding, including UTF\-8. .UNINDENT .INDENT 0.0 .TP .B \-\-verbose, \-v -Increases the amount of internal reporting returned on standard -output or in the log file specified by \fI\-\-logpath\fP\&. Use the -\fB\-v\fP form to control the level of verbosity by including the -option multiple times, (e.g. \fB\-vvvvv\fP\&.) +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 the \fBmongod\fP instance in a quiet mode that attempts to limit -the amount of output. This option suppresses: +Runs \fBmongod\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, -including \fBdrop\fP, \fBdropIndexes\fP, -\fBdiagLogging\fP, \fBvalidate\fP, and -\fBclean\fP\&. +output from \fIdatabase commands\fP .IP \(bu 2 -replication activity. +replication activity .IP \(bu 2 -connection accepted events. +connection accepted events .IP \(bu 2 -connection closed events. +connection closed events .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-port <port> -Specifies a TCP port for the \fBmongod\fP to listen for client -connections. By default \fBmongod\fP listens for connections on -port 27017. -.sp -UNIX\-like systems require root privileges to use ports with numbers -lower than 1024. +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 \-\-bind_ip <ip address> -The IP address that the \fBmongod\fP process will bind to and -listen for connections. By default \fBmongod\fP listens for -connections all interfaces. You may attach \fBmongod\fP to any -interface; however, when attaching \fBmongod\fP to a publicly -accessible interface ensure that you have implemented proper -authentication and/or firewall restrictions to protect the -integrity of your database. +Specifies the IP address that the \fBmongod\fP process binds to and +listens for connections on. By default \fBmongod\fP listens for +connections for all interfaces. You may attach \fBmongod\fP to any +interface. When attaching \fBmongod\fP to a publicly accessible +interface, ensure that you have implemented proper authentication and +firewall restrictions to protect the integrity of your database. .UNINDENT .INDENT 0.0 .TP .B \-\-maxConns <number> Specifies the maximum number of simultaneous connections that -\fBmongod\fP will accept. This setting will have no effect if -it is higher than your operating system\(aqs configured maximum -connection tracking threshold. +\fBmongod\fP will accept. This setting has no effect if it is +higher than your operating system\(aqs configured maximum connection +tracking threshold. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -You cannot set \fBmaxConns\fP to a value higher -than \fI20000\fP\&. -.UNINDENT -.UNINDENT +Changed in version 2.6: MongoDB removed the upward limit on the \fBmaxConns\fP setting. + .UNINDENT .INDENT 0.0 .TP -.B \-\-objcheck -Forces the \fBmongod\fP to validate all requests from clients -upon receipt to ensure that clients never insert invalid documents -into the database. For objects with a high degree of sub\-document -nesting, \fI\-\-objcheck\fP can have a small impact on -performance. You can set \fI\-\-noobjcheck\fP to disable object -checking at run\-time. +.B \-\-syslog +Sends all logging output to the host\(aqs \fIsyslog\fP system rather +than to standard output or a log file as with \fI\-\-logpath\fP\&. .sp -Changed in version 2.4: MongoDB enables \fI\-\-objcheck\fP by default, to prevent any -client from inserting malformed or invalid BSON into a MongoDB -database. - +\fI\-\-syslog\fP is not supported on Windows. .UNINDENT .INDENT 0.0 .TP -.B \-\-noobjcheck -New in version 2.4. - -.sp -Disables the default document validation that MongoDB performs on all -incoming BSON documents. +.B \-\-syslogFacility <string> +Specifies the facility level used when logging messages to syslog. The +default is \fBuser\fP\&. The value you specify must be supported by your +operating system\(aqs implementation of syslog. To use this option, you +must enable the \fI\-\-syslog\fP option. .UNINDENT .INDENT 0.0 .TP .B \-\-logpath <path> -Specify a path for the log file that will hold all diagnostic +Specifies the path for the log file that holds all diagnostic logging information. .sp Unless specified, \fBmongod\fP will output all log information @@ -180,84 +152,334 @@ process restarts. .INDENT 7.0 .INDENT 3.5 The behavior of the logging system may change in the near -future in response to the \fI\%SERVER-4499\fP case. +future in response to the \fI\%SERVER\-4499\fP case. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-logappend -When specified, this option ensures that \fBmongod\fP appends -new entries to the end of the logfile rather than overwriting the -content of the log when the process restarts. +Appends new entries to the end of the logfile when the \fBmongod\fP restarts +instead of overwriting the content of the log. .UNINDENT .INDENT 0.0 .TP -.B \-\-syslog -New in version 2.1.0. +.B \-\-timeStampFormat <string> +Specifies the time format for timestamps in log messages. Specify one of +the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBctime\fP +T} T{ +Displays timestamps as \fBWed Dec 31 +18:17:54.811\fP\&. +T} +_ +T{ +\fBiso8601\-utc\fP +T} T{ +Displays timestamps in Coordinated Universal Time (UTC) in the +ISO\-8601 format. For example, for New York at the start of the +Epoch: \fB1970\-01\-01T00:00:00.000Z\fP +T} +_ +T{ +\fBiso8601\-local\fP +T} T{ +Default value. Displays timestamps in local time in the ISO\-8601 +format. For example, for New York at the start of the Epoch: +\fB1969\-12\-31T19:00:00.000+0500\fP +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-diaglog <value> +Deprecated since version 2.6. .sp -Sends all logging output to the host\(aqs \fIsyslog\fP system rather -than to standard output or a log file as with \fI\-\-logpath\fP\&. +\fI\%\-\-diaglog\fP is for internal use and not intended for most users. .sp -\fBIMPORTANT:\fP +Creates a very verbose, \fIdiagnostic log\fP for troubleshooting and +recording various errors. MongoDB writes these log files in the +\fBdbpath\fP directory in a series of files that begin with the +string \fBdiaglog\fP and end with the initiation time of the logging as a +hex string. +.sp +The specified value configures the level of verbosity. Possible values, +and their impact are as follows. +.TS +center; +|l|l|. +_ +T{ +\fBValue\fP +T} T{ +\fBSetting\fP +T} +_ +T{ +0 +T} T{ +off. No logging. +T} +_ +T{ +1 +T} T{ +Log write operations. +T} +_ +T{ +2 +T} T{ +Log read operations. +T} +_ +T{ +3 +T} T{ +Log both read and write operations. +T} +_ +T{ +7 +T} T{ +Log write and some read operations. +T} +_ +.TE +.sp +You can use the \fBmongosniff\fP tool to replay this output for +investigation. Given a typical diaglog file, located at +\fB/data/db/diaglog.4f76a58c\fP, you might use a command in the following +form to read these files: .INDENT 7.0 .INDENT 3.5 -You cannot use \fI\-\-syslog\fP with \fI\-\-logpath\fP\&. +.sp +.nf +.ft C +mongosniff \-\-source DIAGLOG /data/db/diaglog.4f76a58c +.ft P +.fi .UNINDENT .UNINDENT +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Setting the diagnostic level to \fB0\fP will cause \fBmongod\fP +to stop writing data to the \fIdiagnostic log\fP file. However, +the \fBmongod\fP instance will continue to keep the file open, +even if it is no longer writing data to the file. If you want to +rename, move, or delete the diagnostic log you must cleanly shut +down the \fBmongod\fP instance before doing so. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-traceExceptions +For internal diagnostic use only. .UNINDENT .INDENT 0.0 .TP .B \-\-pidfilepath <path> -Specify a file location to hold the "\fIPID\fP" or process ID of -the \fBmongod\fP process. Useful for tracking the -\fBmongod\fP process in combination with the \fImongod \-\-fork\fP -option. +Specifies a file location to hold the "\fIPID\fP" or process ID of the +\fBmongod\fP process. Useful for tracking the \fBmongod\fP process in +combination with the \fI\-\-fork\fP option. .sp -Without a specified \fI\-\-pidfilepath\fP option, -\fBmongos\fP creates no PID file. +Without a specified \fI\-\-pidfilepath\fP option, \fBmongod\fP +creates no PID file. .UNINDENT .INDENT 0.0 .TP .B \-\-keyFile <file> -Specify the path to a key file to store authentication -information. This option is only useful for the connection between -replica set members. +Specifies the path to a key file to store authentication +information. This option is used for interprocess authentication among +the \fBmongos\fP and \fBmongod\fP instances of a +\fIsharded cluster\fP or \fIreplica set\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-setParameter <options> +New in version 2.4. + .sp -\fBSEE ALSO:\fP +Specifies an option to configure on startup. Specify multiple options +with multiple \fI\-\-setParameter\fP options. See +http://docs.mongodb.org/manual/reference/parameters for full documentation of these parameters. +The \fBsetParameter\fP database command provides access to many +of these parameters. \fI\-\-setParameter\fP supports the following +options: +.INDENT 7.0 +.IP \(bu 2 +\fBenableLocalhostAuthBypass\fP +.IP \(bu 2 +\fBenableTestCommands\fP +.IP \(bu 2 +\fBjournalCommitInterval\fP +.IP \(bu 2 +\fBlogLevel\fP +.IP \(bu 2 +\fBlogUserIds\fP +.IP \(bu 2 +\fBnotablescan\fP +.IP \(bu 2 +\fBquiet\fP +.IP \(bu 2 +\fBreplApplyBatchSize\fP +.IP \(bu 2 +\fBreplIndexPrefetch\fP +.IP \(bu 2 +\fBsupportCompatibilityFormPrivilegeDocuments\fP +.IP \(bu 2 +\fBsyncdelay\fP +.IP \(bu 2 +\fBtextSearchEnabled\fP +.IP \(bu 2 +\fBtraceExceptions\fP +.IP \(bu 2 +\fBsaslauthdPath\fP +.IP \(bu 2 +\fBauthenticationMechanisms\fP +.IP \(bu 2 +\fBsslMode\fP +.IP \(bu 2 +\fBclusterAuthMode\fP +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-httpinterface +New in version 2.6. + +.sp +Enables the HTTP interface. Enabling the interface can increase +network exposure. +.sp +Leave the HTTP interface \fIdisabled\fP for production deployments. If you +\fIdo\fP enable this interface, you should only allow trusted clients to +access this port. See \fIsecurity\-firewalls\fP\&. +.sp +\fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -\fIReplica Set Security\fP -and http://docs.mongodb.org/manual/administration/replica\-sets\&. +In MongoDB Enterprise, the HTTP Console does not support Kerberos +Authentication. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP +.B \-\-nohttpinterface +Deprecated since version 2.6: MongoDB disables the HTTP interface by default. + +.sp +Disables the HTTP interface. +.sp +Do not use in conjunction with \fI\%\-\-rest\fP or \fI\-\-jsonp\fP\&. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +In MongoDB Enterprise, the HTTP Console does not support Kerberos +Authentication. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-clusterAuthMode <option> +New in version 2.6. + +.sp +Enables \fIinternal x.509 authentication\fP for membership to the cluster or replica +set. The \fI\-\-clusterAuthMode\fP option can have one of the +following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBkeyFile\fP +T} T{ +Default value. Use keyfile for authentication. +T} +_ +T{ +\fBsendKeyFile\fP +T} T{ +For rolling upgrade purposes. Send the keyfile for +authentication but can accept either keyfile or x.509 +certificate. +T} +_ +T{ +\fBsendX509\fP +T} T{ +For rolling upgrade purposes. Send the x.509 certificate for +authentication but can accept either keyfile or x.509 +certificate. +T} +_ +T{ +\fBx509\fP +T} T{ +Recommended. Send the x.509 certificate for authentication and +accept \fBonly\fP x.509 certificate. +T} +_ +.TE +.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 \-\-nounixsocket Disables listening on the UNIX socket. \fBmongod\fP always -listens on the UNIX socket, unless \fI\-\-nounixsocket\fP is set, -\fI\-\-bind_ip\fP is \fInot\fP set, or \fI\-\-bind_ip\fP does \fInot\fP -specify \fB127.0.0.1\fP\&. +listens on the UNIX socket, unless either: \fI\-\-nounixsocket\fP +is set, \fBbind_ip\fP is not set, or \fBbind_ip\fP +does not specify \fB127.0.0.1\fP\&. +.sp +New in version 2.6: \fBmongod\fP installed from official \fB\&.deb\fP and \fB\&.rpm\fP packages +have the \fBbind_ip\fP configuration set to \fB127.0.0.1\fP by +default. + .UNINDENT .INDENT 0.0 .TP .B \-\-unixSocketPrefix <path> -Specifies a path for the UNIX socket. Unless this option has a -value \fBmongod\fP creates a socket with \fB/tmp\fP as a -prefix. +Specifies a path for the UNIX socket. If this option has no +value, \fBmongod\fP creates a socket with \fB/tmp\fP as a prefix. .sp -MongoDB will \fIalways\fP create and listen on a UNIX socket, unless -\fI\-\-nounixsocket\fP is set, \fI\-\-bind_ip\fP is \fInot\fP set, -or \fI\-\-bind_ip\fP does \fInot\fP specify \fB127.0.0.1\fP\&. +MongoDB will always create and listen on a UNIX socket, unless +\fI\-\-nounixsocket\fP is set, \fBbind_ip\fP is not set, +or \fBbind_ip\fP does not specify \fB127.0.0.1\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-fork Enables a \fIdaemon\fP mode for \fBmongod\fP that runs the -process to the background. This is the normal mode of operation, in -production and production\-like environments, but may \fInot\fP be +process in the background. This is the normal mode of operation in +production and production\-like environments but may not be desirable for testing. .UNINDENT .INDENT 0.0 @@ -268,47 +490,75 @@ hosts. Configure users via the \fBmongo shell\fP\&. If no users exist, the local will continue to have access to the database until the you create the first user. .sp -See the \fBSecurity and Authentication\fP -page for more information regarding this functionality. +See \fBSecurity and Authentication\fP +for more information. .UNINDENT .INDENT 0.0 .TP -.B \-\-cpu -Forces \fBmongod\fP to report the percentage of CPU time in -write lock. \fBmongod\fP generates output every four -seconds. MongoDB writes this data to standard output or the logfile -if using the \fBlogpath\fP option. +.B \-\-noauth +Disables authentication. Currently the default. Exists for future +compatibility and clarity. .UNINDENT .INDENT 0.0 .TP -.B \-\-dbpath <path> -Specify a directory for the \fBmongod\fP instance to store its -data. Typical locations include: \fB/srv/mongodb\fP, -\fB/var/lib/mongodb\fP or \fB/opt/mongodb\fP +.B \-\-ipv6 +Enables IPv6 support, which allows \fBmongod\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongod\fP, disable IPv6 support by default. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-jsonp +Permits \fIJSONP\fP access via an HTTP interface. Consider the +security implications of allowing this activity before enabling this +option. If the HTTP interface is disabled, the \fI\-\-jsonp\fP also +enables the HTTP interface. .sp -Unless specified, \fBmongod\fP will look for data files in the -default \fB/data/db\fP directory. (Windows systems use the -\fB\edata\edb\fP directory.) If you installed using a package -management system. Check the \fB/etc/mongodb.conf\fP file provided by -your packages to see the configuration of the \fBdbpath\fP\&. +\fBSEE ALSO:\fP +.INDENT 7.0 +.INDENT 3.5 +\fI\-\-httpinterface\fP +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-diaglog <value> -Creates a very verbose, \fIdiagnostic log\fP for troubleshooting -and recording various errors. MongoDB writes these log files in the -\fBdbpath\fP directory in a series of files that begin with -the string \fBdiaglog\fP and end with the initiation time of the -logging as a hex string. -.sp -The specified value configures the level of verbosity. Possible -values, and their impact are as follows. +.B \-\-rest +Enables the simple \fIREST\fP API. Consider the security +implications of allowing this activity before enabling this option. +.sp +If the HTTP interface is disabled, the \fI\%\-\-rest\fP setting +also enables the HTTP interface. +.sp +\fBSEE ALSO:\fP +.INDENT 7.0 +.INDENT 3.5 +\fI\-\-httpinterface\fP to enable the HTTP interface. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-slowms <value> +Defines the value of "slow," for the \fI\%\-\-profile\fP +option. The database logs all slow queries to the log, even when +the profiler is not turned on. When the database profiler is on, +\fBmongod\fP the profiler writes to the \fBsystem.profile\fP +collection. See the \fBprofile\fP command for more information on the +database profiler. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-profile <level> +Changes the level of database profiling, which inserts information +about operation performance into output of \fBmongod\fP or the log +file. The following levels are available: .TS center; |l|l|. _ T{ -\fBValue\fP +\fBLevel\fP T} T{ \fBSetting\fP T} @@ -316,64 +566,53 @@ _ T{ 0 T} T{ -off. No logging. +Off. No profiling. T} _ T{ 1 T} T{ -Log write operations. +On. Only includes slow operations. T} _ T{ 2 T} T{ -Log read operations. -T} -_ -T{ -3 -T} T{ -Log both read and write operations. -T} -_ -T{ -7 -T} T{ -Log write and some read operations. +On. Includes all operations. T} _ .TE .sp -You can use the \fBmongosniff\fP tool to replay this output -for investigation. Given a typical diaglog file, located at -\fB/data/db/diaglog.4f76a58c\fP, you might use a command in the -following form to read these files: -.INDENT 7.0 -.INDENT 3.5 -.sp -.nf -.ft C -mongosniff \-\-source DIAGLOG /data/db/diaglog.4f76a58c -.ft P -.fi -.UNINDENT +Profiling is off by default. Database profiling can impact database +performance. Enable this option only after careful consideration. .UNINDENT -.sp -\fI\%--diaglog\fP is for internal use and not intended for most -users. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -Setting the diagnostic level to \fB0\fP will cause \fBmongod\fP -to stop writing data to the \fIdiagnostic log\fP file. However, -the \fBmongod\fP instance will continue to keep the file open, -even if it is no longer writing data to the file. If you want to -rename, move, or delete the diagnostic log you must cleanly shut -down the \fBmongod\fP instance before doing so. +.INDENT 0.0 +.TP +.B \-\-cpu +Forces \fBmongod\fP to report the percentage of CPU time in +write lock. \fBmongod\fP generates output every four +seconds. MongoDB writes this data to standard output or the logfile +if using the \fBlogpath\fP option. .UNINDENT +.INDENT 0.0 +.TP +.B \-\-sysinfo +Returns diagnostic system information and then exits. The +information provides the page size, the number of physical pages, +and the number of available physical pages. .UNINDENT +.INDENT 0.0 +.TP +.B \-\-dbpath <path> +Specifies the directory where the \fBmongod\fP instance stores its +data. Typical locations include: \fB/srv/mongodb\fP, \fB/var/lib/mongodb\fP +or \fB/opt/mongodb\fP +.sp +Unless specified, \fBmongod\fP will look for data files in the default +\fB/data/db\fP directory. (Windows systems use the \fB\edata\edb\fP +directory.) If you installed using a package management system. Check +the \fB/etc/mongodb.conf\fP file provided by your packages to see the +configuration of the \fI\-\-dbpath\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -383,9 +622,8 @@ database\(aqs files in a distinct folder. This option will create directories within the \fI\-\-dbpath\fP named for each directory. .sp Use this option in conjunction with your file system and device -configuration so that MongoDB will store data on a number of -distinct disk devices to increase write throughput or disk -capacity. +configuration so that MongoDB will store data on a number of distinct +disk devices to increase write throughput or disk capacity. .sp \fBWARNING:\fP .INDENT 7.0 @@ -444,163 +682,93 @@ test/test.ns .UNINDENT .INDENT 0.0 .TP -.B \-\-journal -Enables operation journaling to ensure write durability and data -consistency. \fBmongod\fP enables journaling by default on -64\-bit builds of versions after 2.0. +.B \-\-noIndexBuildRetry +Stops \fBmongod\fP from rebuilding indexes on the next start\-up after the +program had shut down or stopped in the middle of an index build. .UNINDENT .INDENT 0.0 .TP -.B \-\-journalOptions <arguments> -Provides functionality for testing. Not for general use, and may -affect database integrity. +.B \-\-noprealloc +Disables the preallocation of data files. This shortens the +start up time in some cases and can cause significant performance +penalties during normal operations. .UNINDENT .INDENT 0.0 .TP -.B \-\-journalCommitInterval <value> -Specifies the maximum amount of time for \fBmongod\fP to allow -between journal operations. Possible values are between 2 and 300 -milliseconds. Lower values increase the durability of the journal, -at the expense of disk performance. -.sp -The default journal commit interval is 100 milliseconds if a single -block device (e.g. physical volume, RAID device, or LVM volume) -contains both the journal and the data files. -.sp -If different block devices provide the journal and data files the -default journal commit interval is 30 milliseconds. +.B \-\-nssize <value> +Specifies the default size for namespace files (i.e \fB\&.ns\fP). This +option has no impact on the size of existing namespace files. The +maximum size is 2047 megabytes. .sp -To force \fBmongod\fP to commit to the journal more frequently, -you can specify \fBj:true\fP\&. When a write operation with \fBj:true\fP -is pending, \fBmongod\fP will reduce -\fBjournalCommitInterval\fP to a third of the set value. +The default value is 16 megabytes, which provides for approximately +24,000 namespaces. Each collection, as well as each index, counts as +a namespace. .UNINDENT .INDENT 0.0 .TP -.B \-\-ipv6 -Specify this option to enable IPv6 support. This will allow clients -to connect to \fBmongod\fP using IPv6 -networks. \fBmongod\fP disables IPv6 support by default in -\fBmongod\fP and all utilities. +.B \-\-quota +Enables a maximum limit for the number data files each database can +have. When running with \fI\%\-\-quota\fP, there are a maximum of +8 data files per database. Adjust the quota with the +\fI\%\-\-quotaFiles\fP option. .UNINDENT .INDENT 0.0 .TP -.B \-\-jsonp -Permits \fIJSONP\fP access via an HTTP interface. Consider the -security implications of allowing this activity before enabling -this option. +.B \-\-quotaFiles <number> +Modifies the limit on the number of data files per database. This +option requires the \fI\%\-\-quota\fP setting. The default value +for \fI\%\-\-quotaFiles\fP is 8. .UNINDENT .INDENT 0.0 .TP -.B \-\-noauth -Disable authentication. Currently the default. Exists for future -compatibility and clarity. +.B \-\-smallfiles +Enables a mode where MongoDB uses a smaller default file +size. Specifically, \fI\%\-\-smallfiles\fP reduces the initial +size for data files and limits them to 512 +megabytes. \fI\%\-\-smallfiles\fP also reduces the size of each +\fIjournal\fP files from 1 gigabyte to 128 megabytes. +.sp +Use \fI\%\-\-smallfiles\fP if you have a large number of databases +that each holds a small quantity of data. \fI\%\-\-smallfiles\fP can +lead your \fBmongod\fP to create a large number of files, +which may affect performance for larger databases. .UNINDENT .INDENT 0.0 .TP -.B \-\-nohttpinterface -Disables the HTTP interface. +.B \-\-syncdelay <value> +Controls how much time can pass before MongoDB flushes data to the data +files via an \fIfsync\fP operation. \fBDo not set this value on +production systems.\fP In almost every situation you should not set this +value and use the default setting. .sp -\fBNOTE:\fP +\fBWARNING:\fP .INDENT 7.0 .INDENT 3.5 -In MongoDB Enterprise, the HTTP Console does not support Kerberos -Authentication. -.UNINDENT -.UNINDENT -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-nojournal -Disables the durability journaling. By default, \fBmongod\fP -enables journaling in 64\-bit versions after v2.0. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noprealloc -Disables the preallocation of data files. This will shorten the -start up time in some cases, but can cause significant performance -penalties during normal operations. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-noscripting -Disables the scripting engine. +If you set \fI\%\-\-syncdelay\fP to \fB0\fP, MongoDB will not sync the +memory mapped files to disk. .UNINDENT -.INDENT 0.0 -.TP -.B \-\-notablescan -Forbids operations that require a table scan. .UNINDENT -.INDENT 0.0 -.TP -.B \-\-nssize <value> -Specifies the default size for namespace files (i.e \fB\&.ns\fP). This -option has no impact on the size of existing namespace files. The -maximum size is 2047 megabytes. .sp -The default value is 16 megabytes; this provides for approximately -24,000 namespaces. Each collection, as well as each index, counts as -a namespace. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-profile <level> -Changes the level of database profiling, which inserts information -about operation performance into output of \fBmongod\fP or the log -file. The following levels are available: -.TS -center; -|l|l|. -_ -T{ -\fBLevel\fP -T} T{ -\fBSetting\fP -T} -_ -T{ -0 -T} T{ -Off. No profiling. -T} -_ -T{ -1 -T} T{ -On. Only includes slow operations. -T} -_ -T{ -2 -T} T{ -On. Includes all operations. -T} -_ -.TE +\fBmongod\fP writes data very quickly to the journal and lazily to the +data files. The default \fBsyncdelay\fP setting is 60 seconds. +\fBsyncdelay\fP has no effect on the \fBjournal\fP files or +\fBjournaling\fP\&. .sp -Profiling is off by default. Database profiling can impact database -performance. Enable this option only after careful consideration. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-quota -Enables a maximum limit for the number data files each database can -have. When running with \fI\%--quota\fP, there are a maximum of -8 data files per database. Adjust the quota with the -\fI\%--quotaFiles\fP option. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-quotaFiles <number> -Modify limit on the number of data files per database. This option -requires the \fI\%--quota\fP setting. The default value for -\fI\%--quotaFiles\fP is 8. +The \fBserverStatus\fP command reports the background flush +thread\(aqs status via the \fBbackgroundFlushing\fP field. .UNINDENT .INDENT 0.0 .TP -.B \-\-rest -Enables the simple \fIREST\fP API. +.B \-\-upgrade +Upgrades the on\-disk data format of the files specified by the +\fI\-\-dbpath\fP to the latest version, if needed. +.sp +This option only affects the operation of \fBmongod\fP if the data files +are in an old format. +.sp +In most cases you should \fBnot\fP set this value, so you can exercise the +most control over your upgrade process. See the MongoDB \fI\%release notes\fP (on the download page) for more +information about the upgrade process. .UNINDENT .INDENT 0.0 .TP @@ -626,191 +794,126 @@ from that intact copy, and \fBnot\fP use \fBrepairDatabase\fP\&. .UNINDENT .UNINDENT .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 When using \fIjournaling\fP, there is almost never any need to run \fBrepairDatabase\fP\&. In the event of an unclean shutdown, the server will be able restore the data files to a pristine state automatically. -.UNINDENT -.UNINDENT .sp Changed in version 2.1.2. .sp If you run the repair option \fIand\fP have data in a journal file, -\fBmongod\fP will refuse to start. In these cases you should -start \fBmongod\fP without the \fI\-\-repair\fP option to -allow \fBmongod\fP to recover data from the journal. This will -complete more quickly and will result in a more consistent and -complete data set. -.sp -To continue the repair operation despite the journal files, shut down -\fBmongod\fP cleanly and restart with the \fI\-\-repair\fP -option. +\fBmongod\fP refuses to start. In these cases you should start +\fBmongod\fP without the \fI\-\-repair\fP option to allow \fBmongod\fP +to recover data from the journal. This completes more quickly and is +more likely to produce valid data files. To continue the repair +operation despite the journal files, shut down \fBmongod\fP cleanly and +restart with the \fI\-\-repair\fP option. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\-\-repair\fP copies data from the source data files into -new data files in the \fBrepairpath\fP, and then replaces -the original data files with the repaired data files. \fIIf\fP -\fBrepairpath\fP is on the same device as -\fBdbpath\fP, you \fImay\fP interrupt a \fBmongod\fP -running \fI\-\-repair\fP without affecting the integrity of -the data set. -.UNINDENT -.UNINDENT +\fI\-\-repair\fP copies data from the source data files into new data +files in the \fBrepairpath\fP, and then replaces the original data +files with the repaired data files. \fIIf\fP \fBrepairpath\fP is on the +same device as \fBdbpath\fP, you \fImay\fP interrupt a \fBmongod\fP +running \fI\-\-repair\fP without affecting the integrity of the data +set. .UNINDENT .INDENT 0.0 .TP .B \-\-repairpath <path> -Specifies the root directory containing MongoDB data files, to use +Specifies the root directory containing MongoDB data files to use for the \fI\-\-repair\fP operation. Defaults to a \fB_tmp\fP directory within the \fBdbpath\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-setParameter <options> +.B \-\-objcheck +Forces the \fBmongod\fP to validate all requests from clients upon +receipt to ensure that clients never insert invalid documents into the +database. For objects with a high degree of sub\-document nesting, +\fI\-\-objcheck\fP can have a small impact on performance. You can set +\fI\-\-noobjcheck\fP to disable object checking at runtime. +.sp +Changed in version 2.4: MongoDB enables \fI\-\-objcheck\fP by default, to prevent any +client from inserting malformed or invalid BSON into a MongoDB +database. + +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-noobjcheck New in version 2.4. .sp -Specifies an option to configure on startup. Specify multiple -options with multiple \fI\-\-setParameter\fP options. See -http://docs.mongodb.org/manual/reference/parameters for full documentation of these -parameters. The \fBsetParameter\fP database command provides -access to many of these parameters. \fI\-\-setParameter\fP supports the -following options: -.INDENT 7.0 -.IP \(bu 2 -\fBenableLocalhostAuthBypass\fP -.IP \(bu 2 -\fBenableTestCommands\fP -.IP \(bu 2 -\fBjournalCommitInterval\fP -.IP \(bu 2 -\fBlogLevel\fP -.IP \(bu 2 -\fBlogUserIds\fP -.IP \(bu 2 -\fBnotablescan\fP -.IP \(bu 2 -\fBquiet\fP -.IP \(bu 2 -\fBreplApplyBatchSize\fP -.IP \(bu 2 -\fBreplIndexPrefetch\fP -.IP \(bu 2 -\fBsupportCompatibilityFormPrivilegeDocuments\fP -.IP \(bu 2 -\fBsyncdelay\fP -.IP \(bu 2 -\fBtextSearchEnabled\fP -.IP \(bu 2 -\fBtraceExceptions\fP -.UNINDENT +Disables the default document validation that MongoDB performs on all +incoming BSON documents. .UNINDENT .INDENT 0.0 .TP -.B \-\-slowms <value> -Defines the value of "slow," for the \fI\%--profile\fP -option. The database logs all slow queries to the log, even when -the profiler is not turned on. When the database profiler is on, -\fBmongod\fP the profiler writes to the \fBsystem.profile\fP -collection. See the \fBprofile\fP command for more information on the -database profiler. +.B \-\-noscripting +Disables the scripting engine. .UNINDENT .INDENT 0.0 .TP -.B \-\-smallfiles -Enables a mode where MongoDB uses a smaller default file -size. Specifically, \fI\%--smallfiles\fP reduces the initial -size for data files and limits them to 512 -megabytes. \fI\%--smallfiles\fP also reduces the size of each -\fIjournal\fP files from 1 gigabyte to 128 megabytes. -.sp -Use \fI\%--smallfiles\fP if you have a large number of databases -that each holds a small quantity of data. \fI\%--smallfiles\fP can -lead your \fBmongod\fP to create a large number of files, -which may affect performance for larger databases. +.B \-\-notablescan +Forbids operations that require a table scan. .UNINDENT .INDENT 0.0 .TP -.B \-\-shutdown -Used in \fIcontrol scripts\fP, the -\fI\%--shutdown\fP will cleanly and safely terminate the -\fBmongod\fP process. When invoking \fBmongod\fP with this -option you must set the \fI\-\-dbpath\fP option either directly -or by way of the \fBconfiguration file\fP and the \fI\-\-config\fP -option. -.sp -The \fI\%--shutdown\fP option is available only on Linux systems. +.B \-\-journal +Enables operation journaling to ensure write durability and data file +validity. \fBmongod\fP enables journaling by default on +64\-bit builds of versions after 2.0. .UNINDENT .INDENT 0.0 .TP -.B \-\-syncdelay <value> -\fBmongod\fP writes data very quickly to the journal, and -lazily to the data files. \fI\%--syncdelay\fP controls how much -time can pass before MongoDB flushes data to the \fIdatabase files\fP -via an \fIfsync\fP operation. The default setting is 60 seconds. -In almost every situation you should not set this value and use the -default setting. -.sp -The \fBserverStatus\fP command reports the background flush -thread\(aqs status via the \fBbackgroundFlushing\fP -field. -.sp -\fBsyncdelay\fP has no effect on the \fBjournal\fP -files or \fBjournaling\fP\&. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -If you set \fI\%--syncdelay\fP to \fB0\fP, MongoDB will not -sync the memory mapped files to disk. Do not set this value on -production systems. -.UNINDENT -.UNINDENT +.B \-\-nojournal +Disables the durability journaling. By default, \fBmongod\fP +enables journaling in 64\-bit versions after v2.0. .UNINDENT .INDENT 0.0 .TP -.B \-\-sysinfo -Returns diagnostic system information and then exits. The -information provides the page size, the number of physical pages, -and the number of available physical pages. +.B \-\-journalOptions <arguments> +Provides functionality for testing. Not for general use, and will affect data +file integrity in the case of abnormal system shutdown. .UNINDENT .INDENT 0.0 .TP -.B \-\-upgrade -Upgrades the on\-disk data format of the files specified by the -\fI\-\-dbpath\fP to the latest version, if needed. +.B \-\-journalCommitInterval <value> +Specifies the maximum amount of time for \fBmongod\fP to allow +between journal operations. Possible values are between 2 and 300 +milliseconds. Lower values increase the durability of the journal, +at the expense of disk performance. .sp -This option only affects the operation of \fBmongod\fP if the -data files are in an old format. +The default journal commit interval is 100 milliseconds if a single +block device (e.g. physical volume, RAID device, or LVM volume) +contains both the journal and the data files. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -In most cases you should \fBnot\fP set this value, so you can -exercise the most control over your upgrade process. See the MongoDB -\fI\%release notes\fP (on the -download page) for more information about the upgrade process. -.UNINDENT -.UNINDENT +If the journal is on a different block device than the data files the +default journal commit interval is 30 milliseconds. +.sp +To force \fBmongod\fP to commit to the journal more frequently, +you can specify \fBj:true\fP\&. When a write operation with \fBj:true\fP +is pending, \fBmongod\fP will reduce +\fBjournalCommitInterval\fP to a third of the set value. .UNINDENT .INDENT 0.0 .TP -.B \-\-traceExceptions -For internal diagnostic use only. +.B \-\-shutdown +Used in \fIcontrol scripts\fP, the +\fI\%\-\-shutdown\fP cleanly and safely terminates the \fBmongod\fP +process. When invoking \fBmongod\fP with this option you must set the +\fI\-\-dbpath\fP option either directly or by way of the +\fBconfiguration file\fP and the +\fI\-\-config\fP option. +.sp +The \fI\%\-\-shutdown\fP option is available only on Linux systems. .UNINDENT .SS Replication Options .INDENT 0.0 .TP .B \-\-replSet <setname> -Use this option to configure replication with replica sets. Specify -a replica set name as an argument to this set. All hosts in the -replica set must have the same set name. +Configures replication. Specify a replica set name as an argument to +this set. All hosts in the replica set must have the same set name. .sp \fBIMPORTANT:\fP .INDENT 7.0 @@ -820,46 +923,16 @@ should have a distinct name. Some drivers group replica set connections by replica set name. .UNINDENT .UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -http://docs.mongodb.org/manual/replication, -http://docs.mongodb.org/manual/administration/replica\-sets, and -http://docs.mongodb.org/manual/reference/replica\-configuration -.UNINDENT -.UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-oplogSize <value> -Specifies a maximum size in megabytes for the replication operation -log (e.g. \fIoplog\fP\&.) By \fBmongod\fP creates an -\fIoplog\fP based on the maximum amount of space available. For -64\-bit systems, the op log is typically 5% of available disk space. -.sp -Once the \fBmongod\fP has created the oplog for the first -time, changing \fI\%--oplogSize\fP will not affect the size of -the oplog. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-fastsync -In the context of \fIreplica set\fP replication, set this option -if you have seeded this member with a snapshot of the -\fIdbpath\fP of another member of the set. Otherwise the -\fBmongod\fP will attempt to perform an initial sync, -as though the member were a new member. -.sp -\fBWARNING:\fP -.INDENT 7.0 -.INDENT 3.5 -If the data is not perfectly synchronized \fIand\fP -\fBmongod\fP starts with \fBfastsync\fP, then the -secondary or slave will be permanently out of sync with the -primary, which may cause significant consistency problems. -.UNINDENT -.UNINDENT +Specifies a maximum size in megabytes for the replication operation log +(e.g. \fIoplog\fP\&.) By \fBmongod\fP creates an \fIoplog\fP based on +the maximum amount of space available. For 64\-bit systems, the op log is +typically 5% of available disk space. Once the \fBmongod\fP has created +the oplog for the first time, changing \fI\%\-\-oplogSize\fP will not +affect the size of the oplog. .UNINDENT .INDENT 0.0 .TP @@ -867,7 +940,7 @@ primary, which may cause significant consistency problems. New in version 2.2. .sp -You must use \fI\%--replIndexPrefetch\fP in conjunction with +You must use \fI\%\-\-replIndexPrefetch\fP in conjunction with \fBreplSet\fP\&. The default value is \fBall\fP and available options are: .INDENT 7.0 @@ -879,12 +952,12 @@ options are: \fB_id_only\fP .UNINDENT .sp -By default \fIsecondary\fP members of a \fIreplica set\fP will -load all indexes related to an operation into memory before -applying operations from the oplog. You can modify this behavior so -that the secondaries will only load the \fB_id\fP index. Specify -\fB_id_only\fP or \fBnone\fP to prevent the \fBmongod\fP from -loading \fIany\fP index into memory. +By default \fIsecondary\fP members of a \fIreplica set\fP will load +all indexes related to an operation into memory before applying +operations from the oplog. You can modify this behavior so that the +secondaries will only load the \fB_id\fP index. Specify \fB_id_only\fP or +\fBnone\fP to prevent the \fBmongod\fP from loading \fIany\fP index into +memory. .UNINDENT .SS Master\-Slave Replication .sp @@ -894,42 +967,41 @@ replica sets are the preferred configuration for database replication. .INDENT 0.0 .TP .B \-\-master -Configures \fBmongod\fP to run as a replication -\fImaster\fP\&. +Configures \fBmongod\fP to run as a replication \fImaster\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-slave -Configures \fBmongod\fP to run as a replication -\fIslave\fP\&. +Configures \fBmongod\fP to run as a replication \fIslave\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-source <host><:port> -For use with the \fI\%--slave\fP option, the \fB\-\-source\fP option +For use with the \fI\%\-\-slave\fP option, the \fB\-\-source\fP option designates the server that this instance will replicate. .UNINDENT .INDENT 0.0 .TP .B \-\-only <arg> -For use with the \fI\%--slave\fP option, the \fB\-\-only\fP option +For use with the \fI\%\-\-slave\fP option, the \fB\-\-only\fP option specifies only a single \fIdatabase\fP to replicate. .UNINDENT .INDENT 0.0 .TP .B \-\-slavedelay <value> -For use with the \fI\%--slave\fP option, the \fB\-\-slavedelay\fP +For use with the \fI\%\-\-slave\fP option, the \fB\-\-slavedelay\fP option configures a "delay" in seconds, for this slave to wait to apply operations from the \fImaster\fP node. .UNINDENT .INDENT 0.0 .TP .B \-\-autoresync -For use with the \fI\%--slave\fP option. When set, -\fI\%--autoresync\fP option allows this slave to automatically +For use with the \fI\%\-\-slave\fP option. When set, +\fI\%\-\-autoresync\fP option allows this slave to automatically resync if it is more than 10 seconds behind the master. This -setting may be problematic if the \fI\%--oplogSize\fP specifies +setting may be problematic if the \fI\%\-\-oplogSize\fP specifies a too small oplog. +.sp If the \fIoplog\fP is not large enough to store the difference in changes between the master\(aqs current state and the state of the slave, this instance will forcibly resync itself @@ -937,7 +1009,32 @@ unnecessarily. When you set the \fBautoresync\fP option to \fBfalse\fP, the slave will not attempt an automatic resync more than once in a ten minute period. .UNINDENT -.SS Sharding Cluster Options +.INDENT 0.0 +.TP +.B \-\-fastsync +In the context of \fIreplica set\fP replication, set this option +if you have seeded this member with a snapshot of the +\fIdbpath\fP of another member of the set. Otherwise the +\fBmongod\fP will attempt to perform an initial sync, +as though the member were a new member. +.sp +In the context of \fIreplica set\fP replication, set this option +if you have seeded this member with a snapshot of the +\fIdbpath\fP of another member of the set. Otherwise the +\fBmongod\fP will attempt to perform an initial sync, +as though the member were a new member. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If the data is not perfectly synchronized \fIand\fP +\fBmongod\fP starts with \fBfastsync\fP, then the +secondary or slave will be permanently out of sync with the +primary, which may cause significant consistency problems. +.UNINDENT +.UNINDENT +.UNINDENT +.SS Sharded Cluster Options .INDENT 0.0 .TP .B \-\-configsvr @@ -949,14 +1046,14 @@ other than \fBconfig\fP and \fBadmin\fP\&. The default port for a \fI\-\-dbpath\fP directory is \fB/data/configdb\fP, unless specified. .sp -Changed in version 2.2: \fI\%--configsvr\fP also sets \fI\%--smallfiles\fP\&. +Changed in version 2.2: \fI\%\-\-configsvr\fP also sets \fI\%\-\-smallfiles\fP\&. .sp -Changed in version 2.4: \fI\%--configsvr\fP creates a local \fIoplog\fP\&. +Changed in version 2.4: \fI\%\-\-configsvr\fP creates a local \fIoplog\fP\&. .sp -Do not use \fI\%--configsvr\fP with \fI\%--replSet\fP or -\fI\%--shardsvr\fP\&. Config servers cannot be a shard +Do not use \fI\%\-\-configsvr\fP with \fI\%\-\-replSet\fP or +\fI\%\-\-shardsvr\fP\&. Config servers cannot be a shard server or part of a \fIreplica set\fP\&. .UNINDENT .INDENT 0.0 @@ -964,7 +1061,7 @@ server or part of a \fIreplica set\fP\&. .B \-\-shardsvr Configures this \fBmongod\fP instance as a shard in a partitioned cluster. The default port for these instances is -\fB27018\fP\&. The only effect of \fI\%--shardsvr\fP is to change +\fB27018\fP\&. The only effect of \fI\%\-\-shardsvr\fP is to change the port number. .UNINDENT .INDENT 0.0 @@ -973,12 +1070,12 @@ the port number. New in version 2.4. .sp -During chunk migrations, \fI\%--moveParanoia\fP forces the +During chunk migrations, \fI\%\-\-moveParanoia\fP forces the \fBmongod\fP instances to save all documents migrated from this shard in the \fBmoveChunk\fP directory of the \fBdbpath\fP\&. MongoDB does not delete data from this directory. .sp -Prior to 2.4, \fI\%--moveParanoia\fP was the default behavior of +Prior to 2.4, \fI\%\-\-moveParanoia\fP was the default behavior of MongoDB. .UNINDENT .SS SSL Options @@ -992,116 +1089,173 @@ documentation of MongoDB\(aqs support. .UNINDENT .INDENT 0.0 .TP -.B \-\-sslOnNormalPorts -New in version 2.2. +.B \-\-ssl +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. -.UNINDENT +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 \-\-sslMode <mode> +New in version 2.6. + +.sp +Enables SSL or mixed SSL on a port. The argument to the +\fI\-\-sslMode\fP option can be one of the following: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBdisabled\fP +T} T{ +The server does not use SSL. +T} +_ +T{ +\fBallowSSL\fP +T} T{ +Connections between servers do not use SSL. For incoming +connections, the server accepts both SSL and non\-SSL. +T} +_ +T{ +\fBpreferSSL\fP +T} T{ +Connections between servers use SSL. For incoming +connections, the server accepts both SSL and non\-SSL. +T} +_ +T{ +\fBrequireSSL\fP +T} T{ +The server uses and accepts only SSL encrypted connections. +T} +_ +.TE .sp -Enables SSL for \fBmongod\fP\&. With \fI\%--sslOnNormalPorts\fP, -a \fBmongod\fP requires SSL encryption for all connections on the -default MongoDB port, or the port specified by \fI\-\-port\fP\&. By -default, \fI\%--sslOnNormalPorts\fP is disabled. +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 <filename> -New in version 2.2. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. -.UNINDENT -.UNINDENT +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 -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 +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 -When using \fI\%--sslOnNormalPorts\fP, you must specify -\fI\%--sslPEMKeyFile\fP\&. +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 <value> -New in version 2.2. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. +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, \fBmongod\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, \fBmongod\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 \-\-sslClusterFile <filename> +New in version 2.6. + +.sp +Specifies the \fB\&.pem\fP file that contains the x.509 certificate\-key +file for \fImembership authentication\fP +for the cluster or replica set. +.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 \-\-sslClusterPassword <value> +New in version 2.6. + .sp -Specifies the password to de\-crypt the certificate\-key file -(i.e. \fI\%--sslPEMKeyFile\fP). Only use -\fI\%--sslPEMKeyPassword\fP if the certificate\-key file is -encrypted. In all cases, \fBmongod\fP will redact the password from -all logging and reporting output. +Specifies the password to de\-crypt the x.509 certificate\-key file +specified with \fI\-\-sslClusterFile\fP\&. Use +\fI\-\-sslClusterPassword\fP only if the certificate\-key file is +encrypted. In all cases, \fBmongod\fP will redact the password from all +logging and reporting output. .sp -Changed in version 2.4: \fI\%--sslPEMKeyPassword\fP is only needed when the private -key is encrypted. In earlier versions \fBmongod\fP would require -\fI\%--sslPEMKeyPassword\fP whenever using -\fI\%--sslOnNormalPorts\fP, even when the private key was not -encrypted. +Changed in version 2.6: If the x.509 key file is encrypted and you do +not specify \fI\-\-sslClusterPassword\fP, \fBmongod\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 \-\-sslCAFile <filename> -New in version 2.4. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. -.UNINDENT -.UNINDENT +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 -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 +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 <filename> -New in version 2.4. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. -.UNINDENT +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 -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 +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 @@ -1109,72 +1263,187 @@ file using relative or absolute paths New in version 2.4. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. -.UNINDENT -.UNINDENT -.sp -Disables the requirement for SSL certificate validation, that -\fI\%--sslCAFile\fP enables. With -\fI\%--sslWeakCertificateValidation\fP, \fBmongod\fP will accept -connections if the client does not present a certificate when +Disables the requirement for SSL certificate validation that +\fI\-\-sslCAFile\fP enables. With +\fI\-\-sslWeakCertificateValidation\fP, \fBmongod\fP will accept +connections when the client does not present a certificate when establishing the connection. .sp If the client presents a certificate and \fBmongod\fP has -\fI\%--sslWeakCertificateValidation\fP enabled, \fBmongod\fP -will validate the certificate using the root certificate chain -specified by \fI\%--sslCAFile\fP, and reject clients with invalid -certificates. +\fI\-\-sslWeakCertificateValidation\fP enabled, \fBmongod\fP will +validate the certificate using the root certificate chain specified by +\fI\-\-sslCAFile\fP and reject clients with invalid certificates. .sp -Use \fI\%--sslWeakCertificateValidation\fP if you have a mixed +Use \fI\-\-sslWeakCertificateValidation\fP if you have a mixed deployment that includes clients that do not or cannot present certificates to \fBmongod\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 \-\-sslFIPSMode -New in version 2.4. +New in version 2.6. .sp +Directs \fBmongod\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 +.SS Audit Options +.INDENT 0.0 +.TP +.B \-\-auditDestination +Enables auditing. The \fI\-\-auditDestination\fP option can have one of +the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBsyslog\fP +T} T{ +Output the audit events to syslog in JSON format. Not available on +Windows. Audit messages have a syslog severity level of \fBinfo\fP +and a facility level of \fBuser\fP\&. +.sp +The syslog message limit can result in the truncation of the audit +messages. The auditing system will neither detect the truncation nor +error upon its occurrence. +T} +_ +T{ +\fBconsole\fP +T} T{ +Output the audit events to \fBstdout\fP in JSON format. +T} +_ +T{ +\fBfile\fP +T} T{ +Output the audit events to the file specified in +\fI\-\-auditPath\fP in the format specified in +\fI\-\-auditFormat\fP\&. +T} +_ +.TE +.sp \fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -The \fI\%default distribution of MongoDB\fP does \fBnot\fP contain support -for SSL. To use SSL you can either compile MongoDB with SSL support -or use MongoDB Enterprise\&. See http://docs.mongodb.org/manual/tutorial/configure\-ssl for -more information about SSL and MongoDB. +The \fBaudit system\fP is +available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT .UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-auditFormat +Specifies the format of the output file if +\fI\-\-auditDestination\fP is \fBfile\fP\&. The +\fI\-\-auditFormat\fP can have one of the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBJSON\fP +T} T{ +Output the audit events in JSON format to the file specified +in \fI\-\-auditPath\fP\&. +T} +_ +T{ +\fBBSON\fP +T} T{ +Output the audit events in BSON binary format to the file +specified in \fI\-\-auditPath\fP\&. +T} +_ +.TE +.sp +Printing audit events to a file in JSON format degrades server +performance more than printing to a file in BSON format. .sp -When specified, \fBmongod\fP will use the FIPS mode of the -installed OpenSSL library. Your system must have a FIPS compliant -OpenSSL library to use \fI\%--sslFIPSMode\fP\&. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The \fBaudit system\fP is +available only in \fI\%MongoDB Enterprise\fP\&. +.UNINDENT .UNINDENT -.SH USAGE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-auditPath +Specifies the output file for auditing if \fI\-\-auditDestination\fP +has value of \fBfile\fP\&. The \fI\-\-auditPath\fP option can take +either a full path name or a relative path name. .sp -In common usage, the invocation of \fBmongod\fP will resemble the -following in the context of an initialization or control script: +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The \fBaudit system\fP is +available only in \fI\%MongoDB Enterprise\fP\&. +.UNINDENT +.UNINDENT +.UNINDENT .INDENT 0.0 +.TP +.B \-\-auditFilter +Specifies the filter to limit the \fItypes of operations\fP the audit system records. The option +takes a document of the form: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ atype: <expression> } +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +For authentication operations, the option can also take a document of +the form: +.INDENT 7.0 .INDENT 3.5 .sp .nf .ft C -mongod \-\-config /etc/mongodb.conf +{ atype: <expression>, "param.db": <database> } .ft P .fi .UNINDENT .UNINDENT .sp -See the http://docs.mongodb.org/manual/reference/configuration\-options for more information -on how to configure \fBmongod\fP using the configuration file. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The \fBaudit system\fP is +available only in \fI\%MongoDB Enterprise\fP\&. +.UNINDENT +.UNINDENT +.UNINDENT .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongodump.1 b/debian/mongodump.1 index e7f797de680..99cdc68abe4 100644 --- a/debian/mongodump.1 +++ b/debian/mongodump.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGODUMP" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGODUMP" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongodump \- MongoDB +mongodump \- MongoDB Data Dump Utility . .nr rst2man-indent-level 0 . @@ -30,18 +30,6 @@ 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 .. -.INDENT 0.0 -.IP \(bu 2 -\fI\%Synopsis\fP -.IP \(bu 2 -\fI\%Options\fP -.IP \(bu 2 -\fI\%Behavior\fP -.IP \(bu 2 -\fI\%Required User Privileges\fP -.IP \(bu 2 -\fI\%Usage\fP -.UNINDENT .SH SYNOPSIS .sp \fBmongodump\fP is a utility for creating a binary export of the @@ -54,23 +42,6 @@ restore databases. instances, in addition to reading directly from MongoDB data files without an active \fBmongod\fP\&. .sp -\fBIMPORTANT:\fP -.INDENT 0.0 -.INDENT 3.5 -\fBmongodump\fP does \fInot\fP create output for the -\fBlocal\fP database. -.UNINDENT -.UNINDENT -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -The format of data created by \fBmongodump\fP tool from the -2.2 distribution or later is different and incompatible with -earlier versions of \fBmongod\fP\&. -.UNINDENT -.UNINDENT -.sp \fBSEE ALSO:\fP .INDENT 0.0 .INDENT 3.5 @@ -79,6 +50,59 @@ http://docs.mongodb.org/manual/tutorial/backup\-sharded\-cluster\-with\-database and http://docs.mongodb.org/manual/core/backups\&. .UNINDENT .UNINDENT +.SH BEHAVIOR +.sp +\fBmongodump\fP does \fInot\fP dump the content of the \fBlocal\fP database. +.sp +The data format used by \fBmongodump\fP from version 2.2 or +later is \fIincompatible\fP with earlier versions of \fBmongod\fP\&. +Do not use recent versions of \fBmongodump\fP to back up older +data stores. +.sp +When running \fBmongodump\fP against a \fBmongos\fP instance +where the \fIsharded cluster\fP consists of \fIreplica sets\fP, the \fIread preference\fP of the operation will prefer reads +from \fIsecondary\fP members of the set. +.sp +Changed in version 2.2: When used in combination with \fBfsync\fP or +\fBdb.fsyncLock()\fP, \fBmongod\fP may block some +reads, including those from \fBmongodump\fP, when +queued write operation waits behind the \fBfsync\fP +lock. + +.SH REQUIRED ACCESS +.SS Backup Collections +.sp +To backup all the databases in a cluster via \fBmongodump\fP, you +should have the \fBbackup\fP role. The \fBbackup\fP role provides +all the needed privileges for backing up all database. The role confers no +additional access, in keeping with the policy of \fIleast privilege\fP\&. +.sp +To backup a given database, you must have \fBread\fP access on the database. +Several roles provide this access, including the \fBbackup\fP role. +.sp +To backup the \fBsystem.profile\fP collection in a database, you must have +\fBread\fP access on certain system collections in the database. Several roles +provide this access, including the \fBclusterAdmin\fP and +\fBdbAdmin\fP roles. +.SS Backup Users +.sp +Changed in version 2.6. + +.sp +To backup users and \fIuser\-defined roles\fP for a +given database, you must have access to the \fBadmin\fP database. MongoDB +stores the user data and role definitions for all databases in the +\fBadmin\fP database. +.sp +Specifically, to backup a given database\(aqs users, you must have the +\fBfind\fP \fIaction\fP on the \fBadmin\fP +database\(aqs \fBadmin.system.users\fP collection. The \fBbackup\fP +and \fBuserAdminAnyDatabase\fP roles both provide this privilege. +.sp +To backup the user\-defined roles on a database, you must have the +\fBfind\fP action on the \fBadmin\fP database\(aqs +\fBadmin.system.roles\fP collection. Both the \fBbackup\fP and +\fBuserAdminAnyDatabase\fP roles provide this privilege. .SH OPTIONS .INDENT 0.0 .TP @@ -90,43 +114,52 @@ and http://docs.mongodb.org/manual/core/backups\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBmongodump\fP options and usage. .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\&.) +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 \fBmongodump\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 version of the \fBmongodump\fP utility and exits. +Returns the \fBmongodump\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port> -Specifies a resolvable hostname for the \fBmongod\fP that you wish to -use to create the database dump. By default \fBmongodump\fP will -attempt to connect to a MongoDB process ruining on the localhost -port number \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 names and port numbers. The \fBmongodump\fP -utility will, given the seed of at least one connected set member, -connect to the primary member of that set. This option would resemble: +.B \-\-host <hostname><:port>, \-h +Specifies a resolvable hostname for the \fBmongod\fP to which to +connect. By default \fBmongodump\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 -mongodump \-\-host repl0/mongo0.example.net,mongo0.example.net:27018,mongo1.example.net,mongo2.example.net +<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... .ft P .fi .UNINDENT @@ -138,316 +171,294 @@ specifying the host and port number directly. .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\-\-host\fP option. +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 that allows \fBmongodump\fP to connect to -the MongoDB instance using an IPv6 network. All MongoDB programs -and processes, including \fBmongodump\fP, disable IPv6 support -by default. +Enables IPv6 support, which allows \fBmongodump\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongodump\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 mongodump\&. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -SSL support in mongodump is not compiled into the default -distribution of MongoDB. See -http://docs.mongodb.org/manual/tutorial/configure\-ssl for more information on SSL -and MongoDB. +Enables connection to a \fBmongod\fP or \fBmongos\fP that has +SSL support enabled. .sp -Additionally, mongodump does not support connections to -\fBmongod\fP instances that require client certificate -validation. +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 <filename> +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 <filename> +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 -Allows \fBmongodump\fP to connect to \fBmongod\fP -instance over an SSL connection. +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 <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance, if -your database requires authentication. Use in conjunction with the -\fI\-\-password\fP option to supply a -password. +.B \-\-sslPEMKeyPassword <value> +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, \fBmongodump\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, \fBmongodump\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 \-\-password <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. Use -in conjunction with the \fI\-\-username\fP -option to supply a username. +.B \-\-sslCRLFile <filename> +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 -If you specify a \fI\-\-username\fP and do -not pass an argument to \fI\%--password\fP, \fBmongodump\fP -will prompt for a password interactively. If you do not specify a -password on the command line, \fI\%--password\fP must be the last -argument specified. +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 \-\-authenticationDatabase <dbname> -New in version 2.4. +.B \-\-sslAllowInvalidCertificates +New in version 2.6. .sp -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. +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 -By default, \fBmongodump\fP assumes that the database specified to the -\fI\%--db\fP argument holds the user\(aqs credentials, unless you -specify \fI\%--authenticationDatabase\fP\&. +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 \fBmongodump\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 -See \fBuserSource\fP, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +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 \-\-authenticationMechanism <name> +.B \-\-username <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 <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 <dbname> 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, -\fBmongodump\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. +Specifies the database that holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongodump\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 <name> +New in version 2.4. + .sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +Specifies the authentication mechanism. By default, the authentication +mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response +authentication mechanism. In MongoDB Enterprise, \fBmongodump\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 <path> Specifies the directory of the MongoDB data files. If used, the -\fI\%--dbpath\fP option enables \fBmongodump\fP to attach -directly to local data files and copy the data without the -\fBmongod\fP\&. To run with \fI\%--dbpath\fP, -\fBmongodump\fP needs to restrict access to the data -directory: as a result, no \fBmongod\fP can access the same -path while the process runs. +\fI\-\-dbpath\fP option enables \fBmongodump\fP to attach directly to local data +files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP, +\fBmongodump\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 -Use the \fI\%--directoryperdb\fP in conjunction with the -corresponding option to \fBmongod\fP\&. This option allows -\fBmongodump\fP to read data files organized with each -database located in a distinct directory. This option is only -relevant when specifying the \fI\%--dbpath\fP option. +When used in conjunction with the corresponding option in +\fBmongod\fP, allows \fBmongodump\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 \fBmongodump\fP operations to use the durability -\fIjournal\fP to ensure that the export is in a -consistent state. This option is only relevant when specifying the -\fI\%--dbpath\fP option. +Allows \fBmongodump\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 <db>, \-d <db> -Use the \fI\%--db\fP option to specify a database for -\fBmongodump\fP to backup. If you do not specify a DB, -\fBmongodump\fP copies all databases in this instance into the -dump files. Use this option to backup or copy a smaller subset of -your data. +.B \-\-db <database>, \-d +Specifies a database to backup. If you do not specify a database, +\fBmongodump\fP copies all databases in this instance into the dump +files. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c <collection> -Use the \fI\%--collection\fP option to specify a collection for -\fBmongodump\fP to backup. If you do not specify a collection, -this option copies all collections in the specified database or -instance to the dump files. Use this option to backup or copy a -smaller subset of your data. +.B \-\-collection <collection>, \-c +Specifies a collection to backup. If you do not specify a collection, +this option copies all collections in the specified database or instance +to the dump files. .UNINDENT .INDENT 0.0 .TP -.B \-\-out <path>, \-o <path> -Specifies a directory where \fBmongodump\fP saves the output of -the database dump. By default, \fBmongodump\fP saves output -files in a directory named \fBdump\fP in the current working directory. +.B \-\-out <path>, \-o +Specifies the directory where \fBmongodump\fP saves the output of +the database dump. By default, \fBmongodump\fP saves output files +in a directory named \fBdump\fP in the current working directory. .sp -To send the database dump to standard output, specify "\fB\-\fP" -instead of a path. Write to standard output if you want process the -output before saving it, such as to use \fBgzip\fP to compress the -dump. When writing standard output, \fBmongodump\fP does not -write the metadata that writes in a \fB<dbname>.metadata.json\fP file -when writing to files directly. +To send the database dump to standard output, specify "\fB\-\fP" instead of +a path. Write to standard output if you want process the output before +saving it, such as to use \fBgzip\fP to compress the dump. When writing +standard output, \fBmongodump\fP does not write the metadata that +writes in a \fB<dbname>.metadata.json\fP file when writing to files +directly. .UNINDENT .INDENT 0.0 .TP -.B \-\-query <json>, \-q <json> -Provides a query to limit (optionally) the documents included in -the output of \fBmongodump\fP\&. +.B \-\-query <json>, \-q +Provides a \fIJSON document\fP as a query that optionally limits the +documents included in the output of \fBmongodump\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-oplog -Use this option to ensure that \fBmongodump\fP creates a dump -of the database that includes an \fIoplog\fP, to create a -point\-in\-time snapshot of the state of a \fBmongod\fP instance. To -restore to a specific point\-in\-time backup, use the output created -with this option in conjunction with \fImongorestore \-\-oplogReplay\fP\&. -.sp -Without \fI\%--oplog\fP, if there are write operations during the -dump operation, the dump will not reflect a single moment in -time. Changes made to the database during the update process can -affect the output of the backup. -.sp -\fI\%--oplog\fP has no effect when running \fBmongodump\fP -against a \fBmongos\fP instance to dump the entire contents of -a sharded cluster. However, you can use \fI\%--oplog\fP to dump +Ensures that \fBmongodump\fP creates a dump of +the database that includes a partial \fIoplog\fP containing operations +from the duration of the \fBmongodump\fP operation. This oplog +produces an effective point\-in\-time snapshot of the state of a +\fBmongod\fP instance. To restore to a specific point\-in\-time +backup, use the output created with this option in conjunction with +\fImongorestore \-\-oplogReplay\fP\&. +.sp +Without \fI\%\-\-oplog\fP, if there are write operations during the dump +operation, the dump will not reflect a single moment in time. Changes +made to the database during the update process can affect the output of +the backup. +.sp +\fI\%\-\-oplog\fP has no effect when running \fBmongodump\fP +against a \fBmongos\fP instance to dump the entire contents of a +sharded cluster. However, you can use \fI\%\-\-oplog\fP to dump individual shards. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fI\%--oplog\fP only works against nodes that maintain an -\fIoplog\fP\&. This includes all members of a replica set, as -well as \fImaster\fP nodes in master/slave replication -deployments. -.UNINDENT -.UNINDENT +\fI\%\-\-oplog\fP only works against nodes that maintain an +\fIoplog\fP\&. This includes all members of a replica set, as well as +\fImaster\fP nodes in master/slave replication deployments. +.sp +\fI\%\-\-oplog\fP does not dump the oplog collection. .UNINDENT .INDENT 0.0 .TP .B \-\-repair -Use this option to run a repair option in addition to dumping the -database. The repair option attempts to repair a database that may -be in an inconsistent state as a result of an improper shutdown or +Runs a repair option in addition to dumping the +database. The repair option attempts to repair a database that may be in +an invalid state as a result of an improper shutdown or \fBmongod\fP crash. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -The \fI\%--repair\fP option uses aggressive -data\-recovery algorithms that may produce a large amount of -duplication. -.UNINDENT -.UNINDENT +The \fI\%\-\-repair\fP option uses aggressive data\-recovery algorithms +that may produce a large amount of duplication. .UNINDENT .INDENT 0.0 .TP .B \-\-forceTableScan -Forces \fBmongodump\fP to scan the data store directly: -typically, \fBmongodump\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: +Forces \fBmongodump\fP to scan the data store directly: typically, +\fBmongodump\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: .INDENT 7.0 .IP 1. 3 -If you have key sizes over 800 bytes that would not be present -in the \fB_id\fP index. +If you have key sizes over 800 bytes that would not be present in the +\fB_id\fP index. .IP 2. 3 Your database uses a custom \fB_id\fP field. .UNINDENT .sp -When you run with \fI\%--forceTableScan\fP, \fBmongodump\fP -does not use \fB$snapshot\fP\&. As a result, the dump produced -by \fBmongodump\fP can reflect the state of the database at -many different points in time. +When you run with \fI\-\-forceTableScan\fP, \fBmongodump\fP does +not use \fB$snapshot\fP\&. As a result, the dump produced by +\fBmongodump\fP can reflect the state of the database at many +different points in time. .sp \fBIMPORTANT:\fP .INDENT 7.0 .INDENT 3.5 -Use \fI\%--forceTableScan\fP with extreme caution -and consideration. +Use \fI\-\-forceTableScan\fP with extreme caution and +consideration. .UNINDENT .UNINDENT .UNINDENT -.SH BEHAVIOR -.sp -When running \fBmongodump\fP against a \fBmongos\fP instance -where the \fIsharded cluster\fP consists of \fIreplica sets\fP, the \fIread preference\fP of the operation will prefer reads -from \fIsecondary\fP members of the set. -.sp -\fBWARNING:\fP .INDENT 0.0 -.INDENT 3.5 -Changed in version 2.2: When used in combination with \fBfsync\fP or -\fBdb.fsyncLock()\fP, \fBmongod\fP may block some -reads, including those from \fBmongodump\fP, when -queued write operation waits behind the \fBfsync\fP -lock. - -.UNINDENT +.TP +.B \-\-dumpDbUsersAndRoles +Includes user and role definitions when performing \fBmongodump\fP +on a specific database. This option applies only when you specify a +database in the \fI\-\-db\fP option. MongoDB always includes user and +role definitions when \fBmongodump\fP applies to an entire instance +and not just a specific database. .UNINDENT -.SH REQUIRED USER PRIVILEGES +.SH USE .sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -User privileges changed in MongoDB 2.4. -.UNINDENT -.UNINDENT -.sp -The user must have appropriate privileges to read data from database -holding collections in order to use \fBmongodump\fP\&. Consider the -following \fBrequired privileges\fP for -the following \fBmongodump\fP operations: -.TS -center; -|l|l|. -_ -T{ -Task -T} T{ -Required Privileges -T} -_ -T{ -All collections in a database except \fBsystem.users\fP\&. -T} T{ -\fBread\fP\&. [1] -T} -_ -T{ -All collections in a database, including \fBsystem.users\fP\&. -T} T{ -\fBread\fP [1] and \fBuserAdmin\fP\&. -T} -_ -T{ -All databases. [3] -T} T{ -\fBreadAnyDatabase\fP, \fBuserAdminAnyDatabase\fP, -and \fBclusterAdmin\fP\&. [2] -T} -_ -.TE -.sp -See http://docs.mongodb.org/manual/reference/user\-privileges and -http://docs.mongodb.org/manual/reference/privilege\-documents for more information on user -roles. -.IP [1] 5 -You may provision \fBreadWrite\fP -instead of \fBread\fP\&. -.IP [2] 5 -\fBclusterAdmin\fP provides the ability to -run the \fBlistDatabases\fP command, to list all existing -databases. -.IP [3] 5 -If any database runs with profiling enabled, -\fBmongodump\fP may need the -\fBdbAdminAnyDatabase\fP privilege to dump the -\fBsystem.profile\fP collection. -.SH USAGE -.sp -See the http://docs.mongodb.org/manual/tutorial/backup\-databases\-with\-binary\-database\-dumps +See the http://docs.mongodb.org/manual/tutorial/backup\-with\-mongodump for a larger overview of \fBmongodump\fP usage. Also see the \fBmongorestore\fP document for an overview of the \fBmongorestore\fP, which provides the related inverse @@ -501,6 +512,6 @@ mongodump \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-pas .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongoexport.1 b/debian/mongoexport.1 index 0883293dad1..5fc8182310a 100644 --- a/debian/mongoexport.1 +++ b/debian/mongoexport.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOEXPORT" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOEXPORT" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongoexport \- MongoDB +mongoexport \- MongoDB Export Utility . .nr rst2man-indent-level 0 . @@ -38,17 +38,13 @@ http://docs.mongodb.org/manual/core/import\-export document for a more in depth usage overview, and the \fBmongoimport\fP document for more information regarding the \fBmongoimport\fP utility, which provides the inverse "importing" capability. +.SH CONSIDERATIONS .sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 Do not use \fBmongoimport\fP and \fBmongoexport\fP for -full\-scale 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 kind of -functionality. -.UNINDENT -.UNINDENT +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 +kind of functionality. .SH OPTIONS .INDENT 0.0 .TP @@ -60,34 +56,46 @@ functionality. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBmongoexport\fP options and usage. .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\&.) +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 \fBmongoexport\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 version of the \fBmongoexport\fP utility. +Returns the \fBmongoexport\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port> -Specifies a resolvable hostname for the \fBmongod\fP from which you -want to export data. By default \fBmongoexport\fP attempts to -connect to a MongoDB process ruining on the localhost port number -\fB27017\fP\&. +.B \-\-host <hostname><:port>, \-h +Specifies a resolvable hostname for the \fBmongod\fP to which to +connect. By default \fBmongoexport\fP attempts to connect to a MongoDB instance +running on the localhost on port number \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, you can specify the replica set seed -name, and a seed list of set members, in the following format: +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 @@ -98,143 +106,202 @@ name, and a seed list of set members, in the following format: .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 <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 \fImongoexport \-\-host\fP command. +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 that allows \fBmongoexport\fP to connect -to the MongoDB instance using an IPv6 network. All MongoDB programs -and processes, including \fBmongoexport\fP, disable IPv6 -support by default. +Enables IPv6 support, which allows \fBmongoexport\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongoexport\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 mongoexport\&. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -SSL support in mongoexport is not compiled into the default -distribution of MongoDB. See -http://docs.mongodb.org/manual/tutorial/configure\-ssl for more information on SSL -and MongoDB. +Enables connection to a \fBmongod\fP or \fBmongos\fP that has +SSL support enabled. .sp -Additionally, mongoexport does not support connections to -\fBmongod\fP instances that require client certificate -validation. +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 <filename> +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 <filename> +New in version 2.6. + .sp -Allows \fBmongoexport\fP to connect to \fBmongod\fP -instance over an SSL connection. +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 \-\-username <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance, if your -database requires authentication. Use in conjunction with the -\fImongoexport \-\-password\fP option to supply a password. +.B \-\-sslPEMKeyPassword <value> +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, \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 +\fI\-\-sslPEMKeyPassword\fP, \fBmongoexport\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 \-\-password <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. Use -in conjunction with the \fI\-\-username\fP -option to supply a username. +.B \-\-sslCRLFile <filename> +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 -If you specify a \fI\-\-username\fP and -do not pass an argument to \fI\-\-password\fP, -\fBmongoexport\fP will prompt for a password interactively. If -you do not specify a password on the command line, -\fI\-\-password\fP must be the last argument specified. +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 \-\-authenticationDatabase <dbname> -New in version 2.4. +.B \-\-sslAllowInvalidCertificates +New in version 2.6. .sp -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. +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 -By default, \fBmongoexport\fP assumes that the database specified to the -\fI\-\-db\fP argument holds the user\(aqs credentials, unless you -specify \fI\-\-authenticationDatabase\fP\&. +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 -See \fBuserSource\fP, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +Directs \fBmongoexport\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 \-\-authenticationMechanism <name> +.B \-\-username <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 <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 <dbname> 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, -\fBmongoexport\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. +Specifies the database that holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongoexport\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 <name> +New in version 2.4. + .sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +Specifies the authentication mechanism. By default, the authentication +mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response +authentication mechanism. In MongoDB Enterprise, \fBmongoexport\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 <path> Specifies the directory of the MongoDB data files. If used, the -\fB\-\-dbpath\fP option enables \fBmongoexport\fP to attach -directly to local data files and insert the data without the -\fBmongod\fP\&. To run with \fB\-\-dbpath\fP, \fBmongoexport\fP -needs to lock access to the data directory: as a result, no -\fBmongod\fP can access the same path while the process runs. +\fI\-\-dbpath\fP option enables \fBmongoexport\fP to attach directly to local data +files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP, +\fBmongoexport\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 -Use the \fI\-\-directoryperdb\fP in conjunction with the -corresponding option to \fBmongod\fP, which allows -\fBmongoexport\fP to export data from 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. +When used in conjunction with the corresponding option in +\fBmongod\fP, allows \fBmongoexport\fP to export data from +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 operations to access the durability -\fIjournal\fP to ensure that the export is in a -consistent state. This option is only relevant when specifying the -\fI\-\-dbpath\fP option. +Allows \fBmongoexport\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 <db>, \-d <db> -Use the \fI\-\-db\fP option to specify the name of the database -that contains the collection you want to export. +.B \-\-db <database>, \-d +Specifies the name of the database on which to run \fBmongoexport\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c <collection> -Use the \fI\-\-collection\fP option to specify the collection -that you want \fBmongoexport\fP to export. +.B \-\-collection <collection>, \-c +Specifies the collection to export. .UNINDENT .INDENT 0.0 .TP -.B \-\-fields <field1[,field2]>, \-f <field1[,field2]> -Specify a field or fields to \fIinclude\fP in the export. Use a comma +.B \-\-fields <field1[,field2]>, \-f +Specifies a field or fields to \fIinclude\fP in the export. Use a comma separated list of fields to specify multiple fields. .sp For \fI\-\-csv\fP output formats, @@ -249,29 +316,27 @@ its fields, not just the specified field within the document. .UNINDENT .INDENT 0.0 .TP -.B \-\-fieldFile <file> +.B \-\-fieldFile <filename> As 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\-\-csv\fP -option. The file must have only one field per line, and the line(s) -must end with the LF character (\fB0x0A\fP). +specify in a file the field or fields to \fIinclude\fP in the export and is +\fBonly valid\fP with the \fI\-\-csv\fP option. 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 specified field(s) can be a field within a sub\-document. .UNINDENT .INDENT 0.0 .TP -.B \-\-query <JSON>, \-q <JSON> +.B \-\-query <JSON>, \-q Provides a \fIJSON document\fP as a query that optionally limits -the documents returned in the export. -.INDENT 7.0 -.INDENT 3.5 -.SH EXAMPLE +the documents returned in the export. Specify JSON in \fBstrict +format\fP\&. .sp -Given a collection named \fBrecords\fP in the database \fBtest\fP -with the following documents: -.INDENT 0.0 +For example, given a collection named \fBrecords\fP in the database +\fBtest\fP with the following documents: +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -286,10 +351,10 @@ with the following documents: .UNINDENT .UNINDENT .sp -The following \fBmongoexport\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 0.0 +The following \fBmongoexport\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 .INDENT 3.5 .sp .nf @@ -301,7 +366,7 @@ mongoexport \-d test \-c records \-q "{ a: { \e$gte: 3 } } }" \-\-out exportdir/ .UNINDENT .sp The resulting file contains the following documents: -.INDENT 0.0 +.INDENT 7.0 .INDENT 3.5 .sp .nf @@ -312,22 +377,30 @@ The resulting file contains the following documents: .fi .UNINDENT .UNINDENT -.UNINDENT -.UNINDENT +.sp +You can sort the results with the \fI\%\-\-sort\fP option to +\fBmongoexport\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-csv -Changes the export format to a comma separated values (CSV) +Changes the export format to a comma\-separated\-values (CSV) format. By default \fBmongoexport\fP writes data using one \fIJSON\fP document for every MongoDB document. .sp -If you specify \fI\%--csv\fP, then you must also use either +If you specify \fI\%\-\-csv\fP, then you must also use either 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 +Specifies a file to write the export to. If you do not specify a file +name, the \fBmongoexport\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 @@ -347,20 +420,13 @@ This is the default behavior. .UNINDENT .INDENT 0.0 .TP -.B \-\-out <file>, \-o <file> -Specify a file to write the export to. If you do not specify a file -name, the \fBmongoexport\fP writes data to standard output -(e.g. \fBstdout\fP). -.UNINDENT -.INDENT 0.0 -.TP .B \-\-forceTableScan New in version 2.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 +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: .INDENT 7.0 @@ -371,7 +437,7 @@ 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 +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. @@ -379,12 +445,52 @@ many different points in time. \fBWARNING:\fP .INDENT 7.0 .INDENT 3.5 -Use \fI\-\-forceTableScan\fP with extreme caution +Use \fI\%\-\-forceTableScan\fP with extreme caution and consideration. .UNINDENT .UNINDENT .UNINDENT -.SH USAGE +.INDENT 0.0 +.TP +.B \-\-skip <number> +Use \fI\%\-\-skip\fP to control where \fBmongoexport\fP begins +exporting documents. See \fBskip()\fP for information about +the underlying operation. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-limit <number> +Specifies a maximum number of documents to include in the +export. See \fBlimit()\fP for information about +the underlying operation. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-sort <JSON> +Specifies an ordering for exported results. If an index does +\fBnot\fP exist that can support the sort operation, the results must +be \fIless than\fP 32 megabytes. +.sp +Use \fI\%\-\-sort\fP conjunction with \fI\%\-\-skip\fP and +\fI\%\-\-limit\fP to limit number of exported documents. +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +mongoexport \-d test \-c records \-\-sort \(aq{a: 1}\(aq \-\-limit 100 \-\-out export.0.json +mongoexport \-d test \-c records \-\-sort \(aq{a: 1}\(aq \-\-limit 100 \-\-skip 100 \-\-out export.1.json +mongoexport \-d test \-c records \-\-sort \(aq{a: 1}\(aq \-\-limit 100 \-\-skip 200 \-\-out export.2.json +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +See \fBsort()\fP for information about the underlying +operation. +.UNINDENT +.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 @@ -403,6 +509,7 @@ mongoexport \-\-db users \-\-collection contacts \-\-csv \-\-fieldFile fields.tx .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, @@ -418,6 +525,7 @@ mongoexport \-\-db sales \-\-collection contacts \-\-out contacts.json \-\-journ .fi .UNINDENT .UNINDENT +.SS Export Collection Directly From Data Files .sp The following example exports the collection \fBcontacts\fP from the \fBsales\fP database located in the MongoDB data files located at @@ -442,12 +550,12 @@ connected to the data files located in the \fB/srv/mongodb/\fP directory. .UNINDENT .UNINDENT +.SS Export from Remote Host Running with Authentication .sp -The final example exports the collection \fBcontacts\fP from the +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\&. +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 @@ -458,9 +566,69 @@ mongoexport \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-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, \fBmongoexport\fP uses the \fBstrict +mode representation\fP for certain +types. +.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: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +use test +db.traffic.insert( { _id: 1, volume: NumberLong(2980000), date: new Date() } ) +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Use \fBmongoexport\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 \fBstrict mode representation\fP 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 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-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongofiles.1 b/debian/mongofiles.1 index 95434b1e0ac..9cb2b31dafd 100644 --- a/debian/mongofiles.1 +++ b/debian/mongofiles.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOFILES" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOFILES" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongofiles \- MongoDB +mongofiles \- MongoDB GridFS Utility . .nr rst2man-indent-level 0 . @@ -82,90 +82,175 @@ For \fIreplica sets\fP, .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBmongofiles\fP options and usage. .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\&.) +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 \fBmongofiles\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 version of the \fBmongofiles\fP utility. +Returns the \fBmongofiles\fP release number. .UNINDENT .INDENT 0.0 .TP .B \-\-host <hostname><:port> -Specifies a resolvable hostname for the \fBmongod\fP that -holds your GridFS system. By default \fBmongofiles\fP attempts -to connect to a MongoDB process ruining on the localhost port -number \fB27017\fP\&. +Specifies a resolvable hostname for the \fBmongod\fP that holds +your GridFS system. By default \fBmongofiles\fP attempts to connect +to a MongoDB process running on the localhost port number \fB27017\fP\&. .sp -Optionally, specify a port number to connect a MongoDB instance -running on a port other than 27017. +Optionally, specify a port number to connect a MongoDB instance running +on a port other than 27017. .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 \fImongofiles \-\-host\fP command. +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 that allows \fBmongofiles\fP to connect -to the MongoDB instance using an IPv6 network. All MongoDB programs -and processes, including \fBmongofiles\fP, disable IPv6 -support by default. +Enables IPv6 support, which allows \fBmongofiles\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongofiles\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 mongofiles\&. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -SSL support in mongofiles is not compiled into the default -distribution of MongoDB. See -http://docs.mongodb.org/manual/tutorial/configure\-ssl for more information on SSL -and MongoDB. +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 <filename> +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 -Additionally, mongofiles does not support connections to -\fBmongod\fP instances that require client certificate -validation. +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 <filename> +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 <value> +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, \fBmongofiles\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, \fBmongofiles\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 <filename> +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 -Allows \fBmongofiles\fP to connect to \fBmongod\fP -instance over an SSL connection. +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 <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance, if your -database requires authentication. Use in conjunction with the -\fImongofiles \-\-password\fP option to supply a password. +.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 \-\-password <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. Use -in conjunction with the \fImongofiles \-\-username\fP option to -supply a username. +.B \-\-sslFIPSMode +New in version 2.6. + +.sp +Directs \fBmongofiles\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 -If you specify a \fI\-\-username\fP and -do not pass an argument to \fI\-\-password\fP, -\fBmongofiles\fP will prompt for a password interactively. If -you do not specify a password on the command line, -\fI\-\-password\fP must be the last argument specified. +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 <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 <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 @@ -173,17 +258,10 @@ you do not specify a password on the command line, New in version 2.4. .sp -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. -.sp -By default, \fBmongofiles\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, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +Specifies the database that holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongofiles\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 @@ -191,82 +269,76 @@ delegated authentication in MongoDB. 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, -\fBmongofiles\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. -.sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +Specifies the authentication mechanism. By default, the authentication +mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response +authentication mechanism. In MongoDB Enterprise, \fBmongofiles\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 <path> Specifies the directory of the MongoDB data files. If used, the -\fI\-\-dbpath\fP option enables \fBmongofiles\fP to attach directly to -local data files interact with the GridFS data without the -\fBmongod\fP\&. To run with \fI\-\-dbpath\fP, \fBmongofiles\fP needs to lock -access to the data directory: as a result, no \fBmongod\fP can access -the same path while the process runs. +\fI\-\-dbpath\fP option enables \fBmongofiles\fP to attach directly to local data +files without a running \fBmongod\fP\&. When run with \fI\-\-dbpath\fP, +\fBmongofiles\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 -Use the \fI\-\-directoryperdb\fP in conjunction with the corresponding -option to \fBmongod\fP, which allows \fBmongofiles\fP when -running with the \fI\-\-dbpath\fP option and MongoDB uses an -on\-disk format where every database has a distinct +When used in conjunction with the corresponding option in +\fBmongod\fP, allows \fBmongofiles\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 \fBmongofiles\fP operations to use the durability -\fIjournal\fP when running with \fI\-\-dbpath\fP -to ensure that the database maintains a recoverable state. This -forces \fBmongofiles\fP to record all data on disk regularly. +Allows \fBmongofiles\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 <db>, \-d <db> -Use the \fI\-\-db\fP option to specify the MongoDB database that stores -or will store the GridFS files. +.B \-\-db <database>, \-d +Specifies the name of the database on which to run \fBmongofiles\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c <collection> +.B \-\-collection <collection>, \-c This option has no use in this context and a future release may -remove it. See \fI\%SERVER-4931\fP for more information. +remove it. See \fI\%SERVER\-4931\fP for more information. .UNINDENT .INDENT 0.0 .TP -.B \-\-local <filename>, \-l <filename> +.B \-\-local <filename>, \-l Specifies the local filesystem name of a file for get and put operations. .sp -In the \fBmongofiles put\fP and \fBmongofiles get\fP -commands the required \fB<filename>\fP modifier refers to the name -the object will have in GridFS. \fBmongofiles\fP assumes that -this reflects the file\(aqs name on the local file -system. This setting overrides this default. +In the \fBmongofiles put\fP and \fBmongofiles get\fP commands, +the required \fB<filename>\fP modifier refers to the name the object will +have in GridFS. \fBmongofiles\fP assumes that this reflects the +file\(aqs name on the local file system. This setting overrides this +default. .UNINDENT .INDENT 0.0 .TP -.B \-\-type <MIME>, t <MIME> -Provides the ability to specify a \fIMIME\fP type to describe the -file inserted into GridFS storage. \fBmongofiles\fP omits this -option in the default operation. +.B \-\-type <MIME> +Provides the ability to specify a \fIMIME\fP type to describe the file +inserted into GridFS storage. \fBmongofiles\fP omits this option in +the default operation. .sp Use only with \fBmongofiles put\fP operations. .UNINDENT .INDENT 0.0 .TP .B \-\-replace, \-r -Alters the behavior of \fBmongofiles put\fP to replace -existing GridFS objects with the specified local file, rather than -adding an additional object with the same name. +Alters the behavior of \fBmongofiles put\fP to replace existing +GridFS objects with the specified local file, rather than adding an +additional object with the same name. .sp In the default operation, files will not be overwritten by a \fBmongofiles put\fP option. @@ -415,6 +487,6 @@ mongofiles \-d records get 32\-corinth.lp .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongoimport.1 b/debian/mongoimport.1 index 28afbb21649..95e9e6f80da 100644 --- a/debian/mongoimport.1 +++ b/debian/mongoimport.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOIMPORT" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOIMPORT" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongoimport \- MongoDB +mongoimport \- MongoDB Import Utility . .nr rst2man-indent-level 0 . @@ -38,18 +38,14 @@ 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 "importing" capability. +provides the inverse "exporting" capability. +.SH CONSIDERATIONS .sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 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. -.UNINDENT -.UNINDENT .SH OPTIONS .INDENT 0.0 .TP @@ -61,43 +57,52 @@ functionality. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.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 the command -line. Increase the verbosity with the \fB\-v\fP form by including -the option multiple times, (e.g. \fB\-vvvvv\fP\&.) +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 version of the \fBmongoimport\fP program. +Returns the \fBmongoimport\fP release number. .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 \fBmongoimport\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. \fBmongoimport\fP will, given the seed of at least -one connected set member, connect to the \fIprimary\fP of that set. This -option would resemble: +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 -\-\-host repl0/mongo0.example.net,mongo0.example.net:27018,mongo1.example.net,mongo2.example.net +<replica_set_name>/<hostname1><:port>,<hostname2:<port>,... .ft P .fi .UNINDENT @@ -109,187 +114,245 @@ specifying the host and port number directly. .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 \fImongoimport \-\-host\fP command. +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 that 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. +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.4: MongoDB added support for SSL connections to \fBmongod\fP -instances in mongoimport\&. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -SSL support in mongoimport is not compiled into the default -distribution of MongoDB. See -http://docs.mongodb.org/manual/tutorial/configure\-ssl for more information on SSL -and MongoDB. +Enables connection to a \fBmongod\fP or \fBmongos\fP that has +SSL support enabled. .sp -Additionally, mongoimport does not support connections to -\fBmongod\fP instances that require client certificate -validation. +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 <filename> +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 <filename> +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 -Allows \fBmongoimport\fP to connect to \fBmongod\fP -instance over an SSL connection. +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 \-\-username <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance, if your -database requires authentication. Use in conjunction with the -\fImongoimport \-\-password\fP option to supply a password. +.B \-\-sslPEMKeyPassword <value> +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 \-\-password <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. Use -in conjunction with the \fImongoimport \-\-username\fP option to -supply a username. +.B \-\-sslCRLFile <filename> +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 -If you specify a \fI\-\-username\fP and -do not pass an argument to \fI\-\-password\fP, -\fBmongoimport\fP will prompt for a password interactively. If -you do not specify a password on the command line, -\fI\-\-password\fP must be the last option. +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 \-\-authenticationDatabase <dbname> -New in version 2.4. +.B \-\-sslAllowInvalidCertificates +New in version 2.6. .sp -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. +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 -By default, \fBmongoimport\fP assumes that the database specified to the -\fI\-\-db\fP argument holds the user\(aqs credentials, unless you -specify \fI\-\-authenticationDatabase\fP\&. +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 -See \fBuserSource\fP, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +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 \-\-authenticationMechanism <name> +.B \-\-username <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 <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 <dbname> 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. +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 <name> +New in version 2.4. + .sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +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 <path> 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 and -insert the data without the \fBmongod\fP\&. To run with -\fB\-\-dbpath\fP, \fBmongoimport\fP needs to lock access to the -data directory: as a result, no \fBmongod\fP can access the -same path while the process runs. +\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 -Use the \fI\-\-directoryperdb\fP in conjunction with the -corresponding option to \fBmongod\fP, which allows -\fBmongoimport\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 +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 \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 +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 <db>, \-d <db> -Use the \fI\-\-db\fP option to specify a database for -\fBmongoimport\fP to import data. +.B \-\-db <database>, \-d +Specifies the name of the database on which to run \fBmongoimport\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-collection <collection>, \-c <collection> -Use the \fI\-\-collection\fP option to specify a collection for -\fBmongoimport\fP to import. +.B \-\-collection <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 <field1<,field2>>, \-f <field1[,field2]> -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. +.B \-\-fields <field1[,field2]>, \-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 <filename> -As an alternative to \fI\%--fields\fP the \fI\%--fieldFile\fP -option allows you to specify a file (e.g. \fB<file>\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. +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 -In \fIcsv\fP and \fItsv\fP exports, ignore empty fields. If not +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 <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. +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 <filename> -Specify the location of a file containing the data to -import. \fBmongoimport\fP will read data from standard input -(e.g. "stdin.") if you do not specify a 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. +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," use the first line as -field names. Otherwise, \fBmongoimport\fP will import the first -line as a distinct document. +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 @@ -299,7 +362,7 @@ 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 +\fI\%\-\-upsertFields\fP \fBmongoimport\fP will upsert on the basis of the \fB_id\fP field. .UNINDENT .INDENT 0.0 @@ -326,17 +389,14 @@ first error rather than continuing the operation despite errors. .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 documents +Accepts the import of data expressed with multiple MongoDB documents within a single \fIJSON\fP array. .sp -Use in conjunction with \fImongoexport \-\-jsonArray\fP to +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 USAGE +.SH USE .sp In this example, \fBmongoimport\fP imports the \fIcsv\fP formatted data in the \fB/opt/backups/contacts.csv\fP into the @@ -353,10 +413,25 @@ mongoimport \-\-db users \-\-collection contacts \-\-type csv \-\-file /opt/back .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. Journaling is explicitly enabled. +number 27017. .INDENT 0.0 .INDENT 3.5 .sp @@ -370,7 +445,6 @@ mongoimport \-\-collection contacts \-\-file contacts.json .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 -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 \fBmongoimport\fP will halt because of the \fI\-\-stopOnError\fP option. @@ -402,9 +476,48 @@ mongoimport \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\-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-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongooplog.1 b/debian/mongooplog.1 index f23ed638aa9..a3ef4d79eb7 100644 --- a/debian/mongooplog.1 +++ b/debian/mongooplog.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOOPLOG" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOOPLOG" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongooplog \- MongoDB +mongooplog \- MongoDB Oplog Utility . .nr rst2man-indent-level 0 . @@ -88,39 +88,49 @@ http://docs.mongodb.org/manual/core/backups, http://docs.mongodb.org/manual/core .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBmongooplog\fP options and usage. .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\&.) +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 \fBmongooplog\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 version of the \fBmongooplog\fP utility. +Returns the \fBmongooplog\fP release number. .UNINDENT .INDENT 0.0 .TP .B \-\-host <hostname><:port>, \-h -Specifies a resolvable hostname for the \fBmongod\fP instance -to which \fBmongooplog\fP will apply \fIoplog\fP operations -retrieved from the serve specified by the \fI\-\-from\fP -option. +Specifies a resolvable hostname for the \fBmongod\fP instance to +which \fBmongooplog\fP will apply \fIoplog\fP operations +retrieved from the server specified by the \fI\-\-from\fP option. .sp -\fBmongooplog\fP assumes that all target \fBmongod\fP -instances are accessible by way of port \fB27017\fP\&. You may, -optionally, declare an alternate port number as part of the -hostname argument. +By default \fBmongooplog\fP attempts to connect to a MongoDB instance running +on the localhost on port number \fB27017\fP\&. .sp -You can always connect directly to a single \fBmongod\fP -instance by specifying the host and port number directly. -.sp -To connect to a replica set, you can specify the replica set seed -name, and a seed list of set members, in the following format: +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 @@ -131,86 +141,151 @@ name, and a seed list of set members, in the following format: .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 of the \fBmongod\fP instance where -\fBmongooplog\fP will apply \fIoplog\fP entries. Only -specify this option if the MongoDB instance that you wish to -connect to is not running on the standard port. (i.e. \fB27017\fP) -You may also specify a port number using the \fI\-\-host\fP command. +\fBmongooplog\fP will apply \fIoplog\fP entries. Specify +this option only if the MongoDB instance to connect to is not +running on the standard port of \fB27017\fP\&. You may also specify a +port number using the \fI\-\-host\fP command. .UNINDENT .INDENT 0.0 .TP .B \-\-ipv6 -Enables IPv6 support that allows \fBmongooplog\fP to connect -to the MongoDB instance using an IPv6 network. All MongoDB programs -and processes, including \fBmongooplog\fP, disable IPv6 -support by default. +Enables IPv6 support, which allows \fBmongooplog\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongooplog\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 mongooplog\&. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -SSL support in mongooplog is not compiled into the default -distribution of MongoDB. See -http://docs.mongodb.org/manual/tutorial/configure\-ssl for more information on SSL -and MongoDB. +Enables connection to a \fBmongod\fP or \fBmongos\fP that has +SSL support enabled. .sp -Additionally, mongooplog does not support connections to -\fBmongod\fP instances that require client certificate -validation. +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 <filename> +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 <filename> +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 -Allows \fBmongooplog\fP to connect to \fBmongod\fP -instance over an SSL connection. +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 \-\-username <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance, if -your database requires authentication. Use in conjunction with the -\fI\-\-password\fP option to supply a -password. +.B \-\-sslPEMKeyPassword <value> +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, \fBmongooplog\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, \fBmongooplog\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 \-\-password <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. Use -in conjunction with the \fI\-\-username\fP -option to supply a username. +.B \-\-sslCRLFile <filename> +New in version 2.6. + .sp -If you specify a \fI\-\-username\fP and -do not pass an argument to \fI\-\-password\fP, -\fBmongooplog\fP will prompt for a password interactively. If -you do not specify a password on the command line, -\fI\-\-password\fP must be the last option. +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 \-\-authenticationDatabase <dbname> -New in version 2.4. +.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 -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. +Directs \fBmongooplog\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 -By default, \fBmongooplog\fP assumes that the database specified to the -\fI\-\-db\fP argument holds the user\(aqs credentials, unless you -specify \fI\-\-authenticationDatabase\fP\&. +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 <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 <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 <dbname> +New in version 2.4. + .sp -See \fBuserSource\fP, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +Specifies the database that holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongooplog\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 @@ -218,79 +293,84 @@ delegated authentication in MongoDB. 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, -\fBmongooplog\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. -.sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +Specifies the authentication mechanism. By default, the authentication +mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response +authentication mechanism. In MongoDB Enterprise, \fBmongooplog\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 <path> Specifies a directory, containing MongoDB data files, to which -\fBmongooplog\fP will apply operations from the \fIoplog\fP -of the database specified with the \fI\-\-from\fP -option. When used, the \fI\-\-dbpath\fP option enables -\fBmongo\fP to attach directly to local data files and write -data without a running \fBmongod\fP instance. To run with -\fI\-\-dbpath\fP, \fBmongooplog\fP needs to restrict access -to the data directory: as a result, no \fBmongod\fP can be +\fBmongooplog\fP will apply operations from the \fIoplog\fP of +the database specified with the \fI\-\-from\fP +option. +.sp +When used, the \fI\-\-dbpath\fP option enables \fBmongo\fP to +attach directly to local data files and write data without a running +\fBmongod\fP instance. +.sp +To run with \fI\-\-dbpath\fP, \fBmongooplog\fP needs to restrict +access to the data directory: as a result, no \fBmongod\fP can be 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\&. This option allows -\fBmongooplog\fP to write to data files organized with each -database located in a distinct directory. This option is only -relevant when specifying the \fI\-\-dbpath\fP option. +When used in conjunction with the corresponding option in +\fBmongod\fP, allows \fBmongooplog\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 \fBmongooplog\fP operations to use the durability -\fIjournal\fP to ensure that the data files will -remain in a consistent state during the writing process. This -option is only relevant when specifying the \fI\-\-dbpath\fP -option. +Allows \fBmongooplog\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 \-\-seconds <number>, \-s <number> -Specify a number of seconds of operations for \fBmongooplog\fP -to pull from the \fIremote host\fP\&. Unless +.B \-\-db <database>, \-d +Specifies the name of the database on which to run \fBmongooplog\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-collection <collection>, \-c +Specifies the collection to export. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-seconds <number>, \-s +Specify a number of seconds of operations for \fBmongooplog\fP to +pull from the \fIremote host\fP\&. Unless specified the default value is \fB86400\fP seconds, or 24 hours. .UNINDENT .INDENT 0.0 .TP .B \-\-from <host[:port]> Specify the host for \fBmongooplog\fP to retrieve \fIoplog\fP -operations from. \fBmongooplog\fP \fIrequires\fP this -option. +operations from. \fBmongooplog\fP \fIrequires\fP this option. .sp Unless you specify the \fI\-\-host\fP option, \fBmongooplog\fP will apply the operations collected with this -option to the oplog of the \fBmongod\fP instance running on -the localhost interface connected to port \fB27017\fP\&. +option to the oplog of the \fBmongod\fP instance running on the +localhost interface connected to port \fB27017\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-oplogns <namespace> -Specify a namespace in the \fI\-\-from\fP -host where the oplog resides. The default value is -\fBlocal.oplog.rs\fP, which is the where \fIreplica set\fP members -store their operation log. However, if you\(aqve copied \fIoplog\fP -entries into another database or collection, use this option to -copy oplog entries stored in another location. -.sp -\fINamespaces\fP take the form of -\fB[database].[collection]\fP\&. +Specify a namespace in the \fI\-\-from\fP host +where the oplog resides. The default value is \fBlocal.oplog.rs\fP, which +is the where \fIreplica set\fP members store their operation log. +However, if you\(aqve copied \fIoplog\fP entries into another database or +collection, use this option to copy oplog entries stored in another +location. Namespaces take the form of \fB[database].[collection]\fP\&. .UNINDENT -.SS Usage +.SH USE .sp Consider the following prototype \fBmongooplog\fP command: .INDENT 0.0 @@ -354,11 +434,10 @@ Here, \fBmongooplog\fP imports \fIoplog\fP operations from the \fBmongod\fP host connected to port \fB27017\fP\&. This migrates operations to the MongoDB data files stored in the \fB/srv/mongodb\fP directory. Additionally \fBmongooplog\fP will use the durability -\fIjournal\fP to ensure that the data files remain in a consistent -state. +\fIjournal\fP to ensure that the data files remain valid. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongoperf.1 b/debian/mongoperf.1 index 3fb4fcbff19..140b5ac744d 100644 --- a/debian/mongoperf.1 +++ b/debian/mongoperf.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOPERF" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOPERF" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongoperf \- MongoDB +mongoperf \- MongoDB Performance Utility . .nr rst2man-indent-level 0 . @@ -69,10 +69,8 @@ Specify options to \fBmongoperf\fP using a JavaScript document. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Displays the options to \fBmongoperf\fP\&. Specify options to -\fBmongoperf\fP with a JSON document described in the -\fI\%Configuration Fields\fP section. +.B \-\-help, \-h +Returns information on \fBmongoperf\fP options and usage. .UNINDENT .INDENT 0.0 .TP @@ -280,6 +278,6 @@ iostat \-xm 2 .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongorestore.1 b/debian/mongorestore.1 index a28a3253dc8..6444fb63e49 100644 --- a/debian/mongorestore.1 +++ b/debian/mongorestore.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGORESTORE" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGORESTORE" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongorestore \- MongoDB +mongorestore \- MongoDB Data Restoration Tool . .nr rst2man-indent-level 0 . @@ -40,6 +40,7 @@ data to an existing database. \fBmongorestore\fP can write data to either \fImongod\fP or \fBmongos\fP instances, in addition to writing directly to MongoDB data files without an active \fBmongod\fP\&. +.SH BEHAVIOR .sp If you restore to an existing database, \fBmongorestore\fP will only insert into the existing database, and does not perform updates @@ -64,14 +65,29 @@ during a restore operation, but \fBmongorestore\fP will not receive errors. .UNINDENT .sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -The format of data created by \fBmongodump\fP tool from the -2.2 distribution or later is different and incompatible with -earlier versions of \fBmongod\fP\&. -.UNINDENT -.UNINDENT +The data format used by \fBmongodump\fP from version 2.2 or +later is \fIincompatible\fP with earlier versions of \fBmongod\fP\&. +Do not use recent versions of \fBmongodump\fP to back up older +data stores. +.SH REQUIRED ACCESS TO RESTORE USER DATA +.sp +Changed in version 2.6. + +.sp +To restore users and \fIuser\-defined roles\fP on a +given database, you must have access to the \fBadmin\fP database. MongoDB +stores the user data and role definitions for all databases in the +\fBadmin\fP database. +.sp +Specifically, to restore users to a given database, you must have the +\fBinsert\fP \fIaction\fP on the \fBadmin\fP +database\(aqs \fBadmin.system.users\fP collection. The \fBrestore\fP +role provides this privilege. +.sp +To restore user\-defined roles to a database, you must have the +\fBinsert\fP action on the \fBadmin\fP database\(aqs +\fBadmin.system.roles\fP collection. The \fBrestore\fP role +provides this privilege. .SH OPTIONS .INDENT 0.0 .TP @@ -83,35 +99,46 @@ earlier versions of \fBmongod\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBmongorestore\fP options and usage. .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). +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 \fBmongorestore\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 version of the \fBmongorestore\fP tool. +Returns the \fBmongorestore\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port> -Specifies a resolvable hostname for the \fBmongod\fP to which -you want to restore the database. By default -\fBmongorestore\fP will attempt to connect to a MongoDB -process running on the localhost port number \fB27017\fP\&. For an -example of \fI\-\-host\fP, see \fIbackup\-restore\-dump\fP\&. -.sp -Optionally, specify a port number to connect a MongoDB instance -running on a port other than \fB27017\fP\&. +.B \-\-host <hostname><:port>, \-h +Specifies a resolvable hostname for the \fBmongod\fP to which to +connect. By default \fBmongorestore\fP attempts to connect to a MongoDB instance +running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, you can specify the replica set seed -name, and a seed list of set members, in the following format: +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 @@ -122,87 +149,149 @@ name, and a seed list of set members, in the following format: .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 <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\-\-host\fP command. For -an example of \fI\-\-port\fP, see \fIbackup\-restore\-dump\fP\&. +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 that allows \fBmongorestore\fP to connect -to the MongoDB instance using an IPv6 network. All MongoDB programs -and processes, including \fBmongorestore\fP, disable IPv6 -support by default. +Enables IPv6 support, which allows \fBmongorestore\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongorestore\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 mongorestore\&. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -SSL support in mongorestore is not compiled into the default -distribution of MongoDB. See -http://docs.mongodb.org/manual/tutorial/configure\-ssl for more information on SSL -and MongoDB. +Enables connection to a \fBmongod\fP or \fBmongos\fP that has +SSL support enabled. .sp -Additionally, mongorestore does not support connections to -\fBmongod\fP instances that require client certificate -validation. +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 <filename> +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 <filename> +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 -Allows \fBmongorestore\fP to connect to \fBmongod\fP -instance over an SSL connection. +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 <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance, if -your database requires authentication. Use in conjunction with the -\fI\-\-password\fP option to supply a -password. For an example of \fI\-\-username\fP, see -\fIbackup\-restore\-dump\fP\&. +.B \-\-sslPEMKeyPassword <value> +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, \fBmongorestore\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, \fBmongorestore\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 \-\-password <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. Use -in conjunction with the \fI\-\-username\fP option to -supply a username. For an example of \fI\-\-password\fP, see -\fIbackup\-restore\-dump\fP\&. +.B \-\-sslCRLFile <filename> +New in version 2.6. + .sp -If you specify a \fI\-\-username\fP and do not pass an argument -to \fI\-\-password\fP, \fBmongorestore\fP will prompt for a -password interactively. If you do not specify a password on the -command line, \fI\-\-password\fP must be the last argument -specified. +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 \-\-authenticationDatabase <dbname> -New in version 2.4. +.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 -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. +Directs \fBmongorestore\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 -By default, \fBmongorestore\fP assumes that the database specified to the -\fI\-\-db\fP argument holds the user\(aqs credentials, unless you -specify \fI\-\-authenticationDatabase\fP\&. +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 <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 <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 <dbname> +New in version 2.4. + .sp -See \fBuserSource\fP, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +Specifies the database that holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongorestore\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 @@ -210,81 +299,70 @@ delegated authentication in MongoDB. 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, -\fBmongorestore\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. -.sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +Specifies the authentication mechanism. By default, the authentication +mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response +authentication mechanism. In MongoDB Enterprise, \fBmongorestore\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 <path> Specifies the directory of the MongoDB data files. If used, the -\fI\-\-dbpath\fP option enables \fBmongorestore\fP to attach -directly to local data files and insert the data without the -\fBmongod\fP\&. To run with \fI\-\-dbpath\fP, -\fBmongorestore\fP needs to lock access to the data directory: -as a result, no \fBmongod\fP can access the same path while the -process runs. For an example of \fI\-\-dbpath\fP, see -\fIbackup\-restore\-dbpath\fP\&. +\fI\%\-\-dbpath\fP option enables \fBmongorestore\fP to attach directly to local data +files without a running \fBmongod\fP\&. When run with \fI\%\-\-dbpath\fP, +\fBmongorestore\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 -Use the \fI\-\-directoryperdb\fP in conjunction with the -corresponding option to \fBmongod\fP, which allows -\fBmongorestore\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. +When used in conjunction with the corresponding option in +\fBmongod\fP, allows \fBmongorestore\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 \fBmongorestore\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. For an -example of \fI\-\-journal\fP, see \fIbackup\-restore\-dbpath\fP\&. +Allows \fBmongorestore\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 <db>, \-d <db> -Use the \fI\-\-db\fP option to specify a database for -\fBmongorestore\fP to restore data \fIinto\fP\&. If the database -doesn\(aqt exist, \fBmongorestore\fP will create the specified -database. If you do not specify a \fB<db>\fP, -\fBmongorestore\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. -.sp -\fI\-\-db\fP does \fInot\fP control which \fIBSON\fP files +.B \-\-db <database>, \-d +Specifies a database for \fBmongorestore\fP to restore data \fIinto\fP\&. +If the database does not exist, \fBmongorestore\fP creates the +database. If you do not specify a \fB<db>\fP, \fBmongorestore\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. +.sp +\fI\%\-\-db\fP does \fInot\fP control which \fIBSON\fP files \fBmongorestore\fP restores. You must use the -\fBmongorestore\fP \fI\%path option\fP to limit that restored data. +\fBmongorestore\fP \fI\%path option\fP to +limit that restored data. .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, \fBmongorestore\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. +.B \-\-collection <collection>, \-c +Specifies a single collection for \fBmongorestore\fP to restore. If +you do not specify \fI\%\-\-collection\fP, \fBmongorestore\fP takes +the collection name from the input filename. If the input file has an +extension, MongoDB omits the extension of the file from the collection +name. .UNINDENT .INDENT 0.0 .TP .B \-\-objcheck -Forces the \fBmongorestore\fP to validate all requests from -clients upon receipt to ensure that clients never insert invalid -documents into the database. For objects with a high degree of -sub\-document nesting, \fI\-\-objcheck\fP can have a small impact -on performance. You can set \fI\%--noobjcheck\fP to disable -object checking at run\-time. +Forces \fBmongorestore\fP to validate all requests from clients +upon receipt to ensure that clients never insert invalid documents into +the database. For objects with a high degree of sub\-document nesting, +\fI\-\-objcheck\fP can have a small impact on performance. You can set +\fI\%\-\-noobjcheck\fP to disable object checking at run\-time. .sp Changed in version 2.4: MongoDB enables \fI\-\-objcheck\fP by default, to prevent any client from inserting malformed or invalid BSON into a MongoDB @@ -302,27 +380,41 @@ incoming BSON documents. .UNINDENT .INDENT 0.0 .TP -.B \-\-filter \(aq<JSON>\(aq -Limits the documents that \fBmongorestore\fP imports to only -those documents that match the JSON document specified as -\fB\(aq<JSON>\(aq\fP\&. Be sure to include the document in single quotes to -avoid interaction with your system\(aqs shell environment. For an -example of \fI\%--filter\fP, see \fIbackup\-restore\-filter\fP\&. +.B \-\-filter <JSON> +Limits the documents that \fBmongorestore\fP imports to only those +documents that match the JSON document specified as \fB\(aq<JSON>\(aq\fP\&. Be +sure to include the document in single quotes to avoid interaction with +your system\(aqs shell environment. For an example of \fI\%\-\-filter\fP, +see \fIbackup\-restore\-filter\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-drop -Modifies the restoration procedure to drop every collection from -the target database before restoring the collection from the dumped -backup. +Modifies the restoration procedure to drop every collection from the +target database before restoring the collection from the dumped backup. .UNINDENT .INDENT 0.0 .TP .B \-\-oplogReplay -Replays the \fIoplog\fP after restoring the dump to ensure that the current -state of the database reflects the point\-in\-time backup captured with -the "\fImongodump \-\-oplog\fP" command. For an example of -\fI\%--oplogReplay\fP, see \fIbackup\-restore\-oplogreplay\fP\&. +Replays the \fIoplog\fP after restoring the dump to ensure that the +current state of the database reflects the point\-in\-time backup captured +with the "\fImongodump \-\-oplog\fP" command. For an example of +\fI\%\-\-oplogReplay\fP, see \fIbackup\-restore\-oplogreplay\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-oplogLimit <timestamp> +New in version 2.2. + +.sp +Prevents \fBmongorestore\fP from applying \fIoplog\fP entries +newer than the \fB<timestamp>\fP\&. Specify \fB<timestamp>\fP values in the +form of \fB<time_t>:<ordinal>\fP, where \fB<time_t>\fP is the seconds since +the UNIX epoch, and \fB<ordinal>\fP represents a counter of operations in +the oplog that occurred in the specified second. +.sp +You must use \fI\%\-\-oplogLimit\fP in conjunction with the +\fI\%\-\-oplogReplay\fP option. .UNINDENT .INDENT 0.0 .TP @@ -332,14 +424,12 @@ version during the restoration process. .UNINDENT .INDENT 0.0 .TP -.B \-\-w <number of replicas per write> +.B \-\-noIndexRestore New in version 2.2. .sp -Specifies the \fIwrite concern\fP for each write operation that -\fBmongorestore\fP writes to the target database. By default, -\fBmongorestore\fP does not wait for a response for -\fIwrite acknowledgment\fP\&. +Prevents \fBmongorestore\fP from restoring and building indexes as +specified in the corresponding \fBmongodump\fP output. .UNINDENT .INDENT 0.0 .TP @@ -347,34 +437,20 @@ Specifies the \fIwrite concern\fP for each write operation that New in version 2.2. .sp -Prevents \fBmongorestore\fP from setting the collection -options, such as those specified by the \fBcollMod\fP -\fIdatabase command\fP, on restored collections. +Prevents \fBmongorestore\fP from setting the collection options, +such as those specified by the \fBcollMod\fP \fIdatabase +command\fP, on restored collections. .UNINDENT .INDENT 0.0 .TP -.B \-\-noIndexRestore -New in version 2.2. - -.sp -Prevents \fBmongorestore\fP from restoring and building -indexes as specified in the corresponding \fBmongodump\fP -output. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-oplogLimit <timestamp> +.B \-\-w <number of replicas per write> New in version 2.2. .sp -Prevents \fBmongorestore\fP from applying \fIoplog\fP entries newer -than the \fB<timestamp>\fP\&. Specify \fB<timestamp>\fP values in the -form of \fB<time_t>:<ordinal>\fP, where \fB<time_t>\fP is the seconds -since the UNIX epoch, and \fB<ordinal>\fP represents a counter of -operations in the oplog that occurred in the specified second. -.sp -You must use \fI\%--oplogLimit\fP in conjunction with the -\fI\%--oplogReplay\fP option. +Specifies the \fIwrite concern\fP for each write operation that +\fBmongorestore\fP writes to the target database. By default, +\fBmongorestore\fP does not wait for a response for \fIwrite +acknowledgment\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -383,9 +459,9 @@ The final argument of the \fBmongorestore\fP command is a directory path. This argument specifies the location of the database dump from which to restore. .UNINDENT -.SH USAGE +.SH USE .sp -See http://docs.mongodb.org/manual/tutorial/backup\-databases\-with\-binary\-database\-dumps +See http://docs.mongodb.org/manual/tutorial/backup\-with\-mongodump for a larger overview of \fBmongorestore\fP usage. Also see the \fBmongodump\fP document for an overview of the \fBmongodump\fP, which provides the related inverse @@ -444,6 +520,6 @@ mongorestore \-\-host mongodb1.example.net \-\-port 37017 \-\-username user \-\- .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongos.1 b/debian/mongos.1 index a3c5e978aed..3b35f05f021 100644 --- a/debian/mongos.1 +++ b/debian/mongos.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOS" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOS" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongos \- MongoDB Shard Utility +mongos \- MongoDB Sharded Cluster Query Router . .nr rst2man-indent-level 0 . @@ -39,32 +39,8 @@ application layer, and determines the location of this data in the From the perspective of the application, a \fBmongos\fP instance behaves identically to any other MongoDB instance. -.sp -\fBNOTE:\fP -.INDENT 0.0 -.INDENT 3.5 -Changed in version 2.1. - -.sp -Some aggregation operations using the \fBaggregate\fP will -cause \fBmongos\fP instances to require more CPU resources -than in previous versions. This modified performance profile may -dictate alternate architecture decisions if you use the -\fIaggregation framework\fP extensively in a sharded environment. -.UNINDENT -.UNINDENT -.sp -\fBSEE ALSO:\fP -.INDENT 0.0 -.INDENT 3.5 -http://docs.mongodb.org/manual/sharding and http://docs.mongodb.org/manual/core/sharding\-introduction\&. -.UNINDENT -.UNINDENT .SH OPTIONS -.INDENT 0.0 -.TP -.B mongos -.UNINDENT +.SS Core Options .INDENT 0.0 .TP .B mongos @@ -72,119 +48,181 @@ http://docs.mongodb.org/manual/sharding and http://docs.mongodb.org/manual/core/ .INDENT 0.0 .TP .B \-\-help, \-h -Returns a basic help and usage text. +Returns information on \fBmongos\fP options and usage. .UNINDENT .INDENT 0.0 .TP .B \-\-version -Returns the version of the \fBmongod\fP daemon. +Returns the \fBmongos\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-config <filename>, \-f <filename> -Specifies a configuration file, that you can use to specify -runtime\-configurations. While the options are equivalent and -accessible via the other command line arguments, the configuration -file is the preferred method for runtime configuration of -mongod. See the http://docs.mongodb.org/manual/reference/configuration\-options document -for more information about these options. -.sp -Not all configuration options for \fBmongod\fP make sense in -the context of \fBmongos\fP\&. +.B \-\-config <filename>, \-f +Specifies a configuration file for runtime configuration options. The +configuration file is the preferred method for runtime configuration of +\fBmongos\fP\&. The options are equivalent to the command\-line +configuration options. See http://docs.mongodb.org/manual/reference/configuration\-options for +more information. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -Ensure the configuration file uses ASCII -encoding. \fBmongod\fP does not support configuration files -with non\-ASCII encoding, including UTF\-8. -.UNINDENT -.UNINDENT +Ensure the configuration file uses ASCII encoding. \fBmongos\fP does not +support configuration files with non\-ASCII encoding, including UTF\-8. .UNINDENT .INDENT 0.0 .TP .B \-\-verbose, \-v -Increases the amount of internal reporting returned on standard -output or in the log file specified by \fI\%--logpath\fP\&. Use the -\fB\-v\fP form to control the level of verbosity by including the -option multiple times, (e.g. \fB\-vvvvv\fP\&.) +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 the \fBmongos\fP instance in a quiet mode that attempts to limit -the amount of output. +Runs \fBmongos\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 \-\-port <port> -Specifies a TCP port for the \fBmongos\fP to listen for client -connections. By default \fBmongos\fP listens for connections on -port 27017. -.sp -UNIX\-like systems require root access to access ports with numbers -lower than 1024. +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 \-\-bind_ip <ip address> -The IP address that the \fBmongos\fP process will bind to and -listen for connections. By default \fBmongos\fP listens for -connections all interfaces. You may attach \fBmongos\fP to any -interface; however, when attaching \fBmongos\fP to a publicly -accessible interface ensure that you have implemented proper -authentication and/or firewall restrictions to protect the -integrity of your database. +Specifies the IP address that the \fBmongos\fP process binds to and +listens for connections on. By default \fBmongos\fP listens for +connections for all interfaces. You may attach \fBmongos\fP to any +interface. When attaching \fBmongos\fP to a publicly accessible +interface, ensure that you have implemented proper authentication and +firewall restrictions to protect the integrity of your database. .UNINDENT .INDENT 0.0 .TP .B \-\-maxConns <number> Specifies the maximum number of simultaneous connections that -\fBmongos\fP will accept. This setting will have no effect if -the value of this setting is higher than your operating system\(aqs -configured maximum connection tracking threshold. -.sp -This is particularly useful for \fBmongos\fP if you have a -client that creates a number of collections but allows them to -timeout rather than close the collections. When you set -\fBmaxConns\fP, ensure the value is slightly higher than the -size of the connection pool or the total number of connections to -prevent erroneous connection spikes from propagating to the members -of a \fIsharded cluster\fP\&. -.sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -You cannot set \fBmaxConns\fP to a value higher -than \fI20000\fP\&. -.UNINDENT +\fBmongos\fP will accept. This setting will have no effect if the +value of this setting is higher than your operating system\(aqs configured +maximum connection tracking threshold. +.sp +This setting is particularly useful for \fBmongos\fP if you have a +client that creates a number of collections but allows them to timeout +rather than close the collections. When you set \fBmaxConns\fP, +ensure the value is slightly higher than the size of the connection pool +or the total number of connections to prevent erroneous connection +spikes from propagating to the members of a \fIsharded cluster\fP\&. +.sp +Changed in version 2.6: MongoDB removed the upward limit on the \fBmaxConns\fP setting. + .UNINDENT +.INDENT 0.0 +.TP +.B \-\-syslog +Sends all logging output to the host\(aqs \fIsyslog\fP system rather +than to standard output or a log file as with \fI\%\-\-logpath\fP\&. +.sp +\fI\%\-\-syslog\fP is not supported on Windows. .UNINDENT .INDENT 0.0 .TP -.B \-\-objcheck -Forces the \fBmongos\fP to validate all requests from clients -upon receipt to ensure that invalid objects are never inserted into -the database. This option has a performance impact, and is not -enabled by default. +.B \-\-syslogFacility <string> +Specifies the facility level used when logging messages to syslog. The +default is \fBuser\fP\&. The value you specify must be supported by your +operating system\(aqs implementation of syslog. To use this option, you +must enable the \fI\%\-\-syslog\fP option. .UNINDENT .INDENT 0.0 .TP .B \-\-logpath <path> -Specify a path for the log file that will hold all diagnostic +Specifies the path for the log file that holds all diagnostic logging information. .sp Unless specified, \fBmongos\fP will output all log information to the standard output. Additionally, unless you also specify -\fI\%--logappend\fP, the logfile will be overwritten when the +\fI\%\-\-logappend\fP, the logfile will be overwritten when the process restarts. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The behavior of the logging system may change in the near +future in response to the \fI\%SERVER\-4499\fP case. +.UNINDENT +.UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-logappend -Specify to ensure that \fBmongos\fP appends additional logging -data to the end of the logfile rather than overwriting the content -of the log when the process restarts. +Appends new entries to the end of the logfile when the \fBmongos\fP restarts +instead of overwriting the content of the log. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-timeStampFormat <string> +Specifies the time format for timestamps in log messages. Specify one of +the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBctime\fP +T} T{ +Displays timestamps as \fBWed Dec 31 +18:17:54.811\fP\&. +T} +_ +T{ +\fBiso8601\-utc\fP +T} T{ +Displays timestamps in Coordinated Universal Time (UTC) in the +ISO\-8601 format. For example, for New York at the start of the +Epoch: \fB1970\-01\-01T00:00:00.000Z\fP +T} +_ +T{ +\fBiso8601\-local\fP +T} T{ +Default value. Displays timestamps in local time in the ISO\-8601 +format. For example, for New York at the start of the Epoch: +\fB1969\-12\-31T19:00:00.000+0500\fP +T} +_ +.TE +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-pidfilepath <path> +Specifies a file location to hold the "\fIPID\fP" or process ID of the +\fBmongos\fP process. Useful for tracking the \fBmongos\fP process in +combination with the \fI\%\-\-fork\fP option. +.sp +Without a specified \fI\%\-\-pidfilepath\fP option, \fBmongos\fP +creates no PID file. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-keyFile <file> +Specifies the path to a key file to store authentication +information. This option is used for interprocess authentication among +the \fBmongos\fP and \fBmongod\fP instances of a +\fIsharded cluster\fP or \fIreplica set\fP\&. .UNINDENT .INDENT 0.0 .TP @@ -192,12 +230,12 @@ of the log when the process restarts. New in version 2.4. .sp -Specifies an option to configure on startup. Specify multiple -options with multiple \fI\%--setParameter\fP options. See -http://docs.mongodb.org/manual/reference/parameters for full documentation of these -parameters. The \fBsetParameter\fP database command provides -access to many of these parameters. \fI\%--setParameter\fP supports the -following options: +Specifies an option to configure on startup. Specify multiple options +with multiple \fI\%\-\-setParameter\fP options. See +http://docs.mongodb.org/manual/reference/parameters for full documentation of these parameters. +The \fBsetParameter\fP database command provides access to many +of these parameters. \fI\%\-\-setParameter\fP supports the following +options: .INDENT 7.0 .IP \(bu 2 \fBenableLocalhostAuthBypass\fP @@ -217,276 +255,612 @@ following options: \fBsyncdelay\fP .IP \(bu 2 \fBtextSearchEnabled\fP +.IP \(bu 2 +\fBuserCacheInvalidationIntervalSecs\fP .UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-syslog -New in version 2.1.0. +.B \-\-httpinterface +New in version 2.6. .sp -Sends all logging output to the host\(aqs \fIsyslog\fP system rather -than to standard output or a log file as with \fI\%--logpath\fP\&. +Enables the HTTP interface. Enabling the interface can increase +network exposure. +.sp +Leave the HTTP interface \fIdisabled\fP for production deployments. If you +\fIdo\fP enable this interface, you should only allow trusted clients to +access this port. See \fIsecurity\-firewalls\fP\&. .sp -\fBIMPORTANT:\fP +\fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -You cannot use \fI\%--syslog\fP with \fI\%--logpath\fP\&. +In MongoDB Enterprise, the HTTP Console does not support Kerberos +Authentication. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-pidfilepath <path> -Specify a file location to hold the \fIPID\fP or process ID of the -\fBmongos\fP process. Useful for tracking the \fBmongos\fP process in -combination with the \fImongos \-\-fork\fP option. +.B \-\-clusterAuthMode <option> +New in version 2.6. + .sp -Without a specified \fI\%--pidfilepath\fP option, -\fBmongos\fP creates no PID file. -.UNINDENT -.INDENT 0.0 -.TP -.B \-\-keyFile <file> -Specify the path to a key file to store authentication -information. This option is only useful for the connection between -\fBmongos\fP instances and components of the \fIsharded cluster\fP\&. -.sp -\fBSEE ALSO:\fP -.INDENT 7.0 -.INDENT 3.5 -\fIsharding\-security\fP -.UNINDENT -.UNINDENT +Enables \fIinternal x.509 authentication\fP for membership to the cluster or replica +set. The \fI\%\-\-clusterAuthMode\fP option can have one of the +following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBkeyFile\fP +T} T{ +Default value. Use keyfile for authentication. +T} +_ +T{ +\fBsendKeyFile\fP +T} T{ +For rolling upgrade purposes. Send the keyfile for +authentication but can accept either keyfile or x.509 +certificate. +T} +_ +T{ +\fBsendX509\fP +T} T{ +For rolling upgrade purposes. Send the x.509 certificate for +authentication but can accept either keyfile or x.509 +certificate. +T} +_ +T{ +\fBx509\fP +T} T{ +Recommended. Send the x.509 certificate for authentication and +accept \fBonly\fP x.509 certificate. +T} +_ +.TE +.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 \-\-nounixsocket Disables listening on the UNIX socket. \fBmongos\fP always -listens on the UNIX socket, unless \fI\%--nounixsocket\fP is set, -\fI\%--bind_ip\fP is \fInot\fP set, or \fI\%--bind_ip\fP does \fInot\fP -specify \fB127.0.0.1\fP\&. +listens on the UNIX socket, unless either: \fI\%\-\-nounixsocket\fP +is set, \fBbind_ip\fP is not set, or \fBbind_ip\fP +does not specify \fB127.0.0.1\fP\&. +.sp +New in version 2.6: \fBmongos\fP installed from official \fB\&.deb\fP and \fB\&.rpm\fP packages +have the \fBbind_ip\fP configuration set to \fB127.0.0.1\fP by +default. + .UNINDENT .INDENT 0.0 .TP .B \-\-unixSocketPrefix <path> -Specifies a path for the UNIX socket. Unless this option has a -value \fBmongos\fP creates a socket with \fB/tmp\fP as a prefix. +Specifies a path for the UNIX socket. If this option has no +value, \fBmongos\fP creates a socket with \fB/tmp\fP as a prefix. .sp -MongoDB will \fIalways\fP create and listen on a UNIX socket, unless -\fI\%--nounixsocket\fP is set, \fI\%--bind_ip\fP is \fInot\fP set, -or \fI\%--bind_ip\fP specifies \fB127.0.0.1\fP\&. +MongoDB will always create and listen on a UNIX socket, unless +\fI\%\-\-nounixsocket\fP is set, \fBbind_ip\fP is not set, +or \fBbind_ip\fP does not specify \fB127.0.0.1\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-fork -Enables a \fIdaemon\fP mode for \fBmongos\fP which forces the -process to the background. This is the normal mode of operation, in -production and production\-like environments, but may \fInot\fP be +Enables a \fIdaemon\fP mode for \fBmongos\fP that runs the +process in the background. This is the normal mode of operation in +production and production\-like environments but may not be desirable for testing. .UNINDENT +.SS Sharded Cluster Options .INDENT 0.0 .TP -.B \-\-configdb <config1>,<config2><:port>,<config3> -Set this option to specify a configuration database -(i.e. \fIconfig database\fP) for the \fIsharded cluster\fP\&. You must -specify either 1 configuration server or 3 configuration servers, -in a comma separated list. +.B \-\-configdb <config1>,<config2>,<config3> +Specifies the \fIconfiguration database\fP for the +\fIsharded cluster\fP\&. You must specify either 1 or 3 configuration +servers, in a comma separated list. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -\fBmongos\fP instances read from the first \fIconfig -server\fP in the list provided. All -\fBmongos\fP instances \fBmust\fP specify the hosts to the -\fI\%--configdb\fP setting in the same order. +All \fBmongos\fP instances \fBmust\fP specify the hosts in the +\fI\%\-\-configdb\fP setting in the in the same order. .sp -If your configuration databases reside in more that one data -center, order the hosts in the \fI\%--configdb\fP argument so -that the config database that is closest to the majority of your -\fBmongos\fP instances is first servers in the list. -.UNINDENT -.UNINDENT +If your configuration databases reside in more that one data center, +order the hosts so that the config database that is closest to the +majority of your \fBmongos\fP instances is first servers in the +list. .sp \fBWARNING:\fP .INDENT 7.0 .INDENT 3.5 -Never remove a config server from the \fI\%--configdb\fP parameter, even if -the config server or servers are not available, or offline. +Never remove a config server from this setting, even if the config +server is not available or offline. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-test -This option is for internal testing use only, and runs unit tests -without starting a \fBmongos\fP instance. +.B \-\-localThreshold +Affects the logic that \fBmongos\fP uses when selecting +\fIreplica set\fP members to pass read operations to from clients. +Specify a value in milliseconds. The default value is \fB15\fP, which +corresponds to the default value in all of the client \fBdrivers\fP\&. +.sp +When \fBmongos\fP receives a request that permits reads to +\fIsecondary\fP members, the \fBmongos\fP will: +.INDENT 7.0 +.IP \(bu 2 +Find the member of the set with the lowest ping time. +.IP \(bu 2 +Construct a list of replica set members that is within a ping time of +15 milliseconds of the nearest suitable member of the set. +.sp +If you specify a value for \fI\%\-\-localThreshold\fP, +\fBmongos\fP will construct the list of replica members that are +within the latency allowed by this value. +.IP \(bu 2 +Select a member to read from at random from this list. +.UNINDENT +.sp +The ping time used for a member compared by the +\fI\%\-\-localThreshold\fP setting is a moving average of recent ping +times, calculated at most every 10 seconds. As a result, some queries +may reach members above the threshold until the \fBmongos\fP +recalculates the average. +.sp +See the \fIreplica\-set\-read\-preference\-behavior\-member\-selection\fP +section of the \fBread preference\fP +documentation for more information. .UNINDENT .INDENT 0.0 .TP .B \-\-upgrade -This option updates the meta data format used by the -\fIconfig database\fP\&. +Updates the meta data format used by the \fIconfig database\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-chunkSize <value> -The value of the \fI\%--chunkSize\fP determines the size of each -\fIchunk\fP, \fIin megabytes\fP, of data distributed around the -\fIsharded cluster\fP\&. The default value is 64 megabytes, which -is the ideal size for chunks in most deployments: larger chunk size -can lead to uneven data distribution, smaller chunk size often -leads to inefficient movement of chunks between nodes. However, in -some circumstances it may be necessary to set a different chunk -size. +Determines the size in megabytes of each \fIchunk\fP in the +\fIsharded cluster\fP\&. The default value is 64 megabytes, which is the +ideal size for chunks in most deployments: larger chunk size can lead to +uneven data distribution; smaller chunk size can lead to inefficient +movement of chunks between nodes. However, in some circumstances it may +be necessary to set a different chunk size. .sp -This option \fIonly\fP sets the chunk size when initializing the -cluster for the first time. If you modify the run\-time option -later, the new value will have no effect. See the -http://docs.mongodb.org/manual/tutorial/modify\-chunk\-size\-in\-sharded\-cluster procedure if you -need to change the chunk size on an existing sharded cluster. +This option \fIonly\fP affects chunk size when you initialize the cluster +for the first time. If you later modify the option, the new value has no +effect. See the http://docs.mongodb.org/manual/tutorial/modify\-chunk\-size\-in\-sharded\-cluster +procedure if you need to change the chunk size on an existing sharded +cluster. .UNINDENT .INDENT 0.0 .TP -.B \-\-ipv6 -Enables IPv6 support to allow clients to connect to \fBmongos\fP -using IPv6 networks. MongoDB disables IPv6 support by default in -\fBmongod\fP and all utilities. +.B \-\-noAutoSplit +Prevents \fBmongos\fP from automatically inserting metadata splits +in a \fIsharded collection\fP\&. If set on all +\fBmongos\fP instances, this prevents MongoDB from creating new +chunks as the data in a collection grows. +.sp +Because any \fBmongos\fP in a cluster can create a split, to +totally disable splitting in a cluster you must set +\fI\%\-\-noAutoSplit\fP on all \fBmongos\fP\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +With \fI\%\-\-noAutoSplit\fP enabled, the data in your sharded +cluster may become imbalanced over time. Enable with caution. +.UNINDENT +.UNINDENT +.UNINDENT +.SS SSL Options +.INDENT 0.0 +.INDENT 3.5 +.SS See +.sp +http://docs.mongodb.org/manual/tutorial/configure\-ssl for full +documentation of MongoDB\(aqs support. +.UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-jsonp -Permits \fIJSONP\fP access via an HTTP interface. Consider the -security implications of allowing this activity before enabling -this option. +.B \-\-sslOnNormalPorts +Deprecated since version 2.6. + +.sp +New in version 2.2. + +.sp +Enables SSL so that \fBmongos\fP requires SSL encryption for all +connections on the default MongoDB port or port specified by +\fI\-\-port\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 \-\-noscripting -Disables the scripting engine. +.B \-\-sslMode <mode> +New in version 2.6. + +.sp +Enables SSL or mixed SSL on a port. The argument to the +\fI\%\-\-sslMode\fP option can be one of the following: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBdisabled\fP +T} T{ +The server does not use SSL. +T} +_ +T{ +\fBallowSSL\fP +T} T{ +Connections between servers do not use SSL. For incoming +connections, the server accepts both SSL and non\-SSL. +T} +_ +T{ +\fBpreferSSL\fP +T} T{ +Connections between servers use SSL. For incoming +connections, the server accepts both SSL and non\-SSL. +T} +_ +T{ +\fBrequireSSL\fP +T} T{ +The server uses and accepts only SSL encrypted connections. +T} +_ +.TE +.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 <filename> +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 \-\-nohttpinterface -New in version 2.1.2. +.B \-\-sslPEMKeyPassword <value> +New in version 2.6. .sp -Disables the HTTP interface. +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, \fBmongos\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, \fBmongos\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 \-\-localThreshold -New in version 2.2. +.B \-\-sslClusterFile <filename> +New in version 2.6. .sp -\fI\%--localThreshold\fP affects the logic that \fBmongos\fP -uses when selecting \fIreplica set\fP members to pass read -operations to from clients. Specify a value to -\fI\%--localThreshold\fP in milliseconds. The default value is -\fB15\fP, which corresponds to the default value in all of the client -\fBdrivers\fP\&. +Specifies the \fB\&.pem\fP file that contains the x.509 certificate\-key +file for \fImembership authentication\fP +for the cluster or replica set. .sp -When \fBmongos\fP receives a request that permits reads to -\fIsecondary\fP members, the \fBmongos\fP will: -.INDENT 7.0 -.INDENT 3.5 +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 -.IP \(bu 2 -find the member of the set with the lowest ping time. -.IP \(bu 2 -construct a list of replica set members that is within a ping -time of 15 milliseconds of the nearest suitable member of the -set. +.TP +.B \-\-sslClusterPassword <value> +New in version 2.6. + .sp -If you specify a value for \fI\%--localThreshold\fP, -\fBmongos\fP will construct the list of replica members -that are within the latency allowed by this value. -.IP \(bu 2 -The \fBmongos\fP will select a member to read from at -random from this list. +Specifies the password to de\-crypt the x.509 certificate\-key file +specified with \fI\%\-\-sslClusterFile\fP\&. Use +\fI\%\-\-sslClusterPassword\fP only if the certificate\-key file is +encrypted. In all cases, \fBmongos\fP will redact the password from all +logging and reporting output. +.sp +Changed in version 2.6: If the x.509 key file is encrypted and you do +not specify \fI\%\-\-sslClusterPassword\fP, \fBmongos\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 \-\-sslCAFile <filename> +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 \-\-sslCRLFile <filename> +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 \-\-sslWeakCertificateValidation +New in version 2.4. + .sp -The ping time used for a set member compared by the -\fI\%--localThreshold\fP setting is a moving average of recent -ping times, calculated, at most, every 10 seconds. As a result, some queries -may reach members above the threshold until the \fBmongos\fP -recalculates the average. +Disables the requirement for SSL certificate validation that +\fI\-\-sslCAFile\fP enables. With +\fI\%\-\-sslWeakCertificateValidation\fP, \fBmongos\fP will accept +connections when the client does not present a certificate when +establishing the connection. .sp -See the \fIreplica\-set\-read\-preference\-behavior\-member\-selection\fP -section of the \fBread preference\fP -documentation for more information. +If the client presents a certificate and \fBmongos\fP has +\fI\%\-\-sslWeakCertificateValidation\fP enabled, \fBmongos\fP will +validate the certificate using the root certificate chain specified by +\fI\-\-sslCAFile\fP and reject clients with invalid certificates. +.sp +Use \fI\%\-\-sslWeakCertificateValidation\fP if you have a mixed +deployment that includes clients that do not or cannot present +certificates to \fBmongos\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 \-\-noAutoSplit -New in version 2.0.7. +.B \-\-sslAllowInvalidCertificates +New in version 2.6. .sp -\fI\%--noAutoSplit\fP prevents \fBmongos\fP from -automatically inserting metadata splits in a \fIsharded -collection\fP\&. If set on all \fBmongos\fP, this will prevent -MongoDB from creating new chunks as the data in a collection -grows. +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 -Because any \fBmongos\fP in a cluster can create a split, -to totally disable splitting in a cluster you must -set \fI\%--noAutoSplit\fP on all \fBmongos\fP\&. +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 -\fBWARNING:\fP +Directs \fBmongos\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 +.SS Audit Options +.INDENT 0.0 +.TP +.B \-\-auditDestination +Enables auditing. The \fI\%\-\-auditDestination\fP option can have one of +the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBsyslog\fP +T} T{ +Output the audit events to syslog in JSON format. Not available on +Windows. Audit messages have a syslog severity level of \fBinfo\fP +and a facility level of \fBuser\fP\&. +.sp +The syslog message limit can result in the truncation of the audit +messages. The auditing system will neither detect the truncation nor +error upon its occurrence. +T} +_ +T{ +\fBconsole\fP +T} T{ +Output the audit events to \fBstdout\fP in JSON format. +T} +_ +T{ +\fBfile\fP +T} T{ +Output the audit events to the file specified in +\fI\%\-\-auditPath\fP in the format specified in +\fI\%\-\-auditFormat\fP\&. +T} +_ +.TE +.sp +\fBNOTE:\fP .INDENT 7.0 .INDENT 3.5 -With \fI\%--noAutoSplit\fP enabled, the data in your sharded -cluster may become imbalanced over time. Enable with caution. +The \fBaudit system\fP is +available only in \fI\%MongoDB Enterprise\fP\&. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-auditFormat +Specifies the format of the output file if +\fI\%\-\-auditDestination\fP is \fBfile\fP\&. The +\fI\%\-\-auditFormat\fP can have one of the following values: +.TS +center; +|l|l|. +_ +T{ +Value +T} T{ +Description +T} +_ +T{ +\fBJSON\fP +T} T{ +Output the audit events in JSON format to the file specified +in \fI\%\-\-auditPath\fP\&. +T} +_ +T{ +\fBBSON\fP +T} T{ +Output the audit events in BSON binary format to the file +specified in \fI\%\-\-auditPath\fP\&. +T} +_ +.TE +.sp +Printing audit events to a file in JSON format degrades server +performance more than printing to a file in BSON format. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The \fBaudit system\fP is +available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT .UNINDENT .UNINDENT -.SS SSL Options .INDENT 0.0 -.INDENT 3.5 -.SS See +.TP +.B \-\-auditPath +Specifies the output file for auditing if \fI\%\-\-auditDestination\fP +has value of \fBfile\fP\&. The \fI\%\-\-auditPath\fP option can take +either a full path name or a relative path name. .sp -http://docs.mongodb.org/manual/tutorial/configure\-ssl for full -documentation of MongoDB\(aqs support. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The \fBaudit system\fP is +available only in \fI\%MongoDB Enterprise\fP\&. +.UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP -.B \-\-authenticationDatabase <dbname> -New in version 2.4. - +.B \-\-auditFilter +Specifies the filter to limit the \fItypes of operations\fP the audit system records. The option +takes a document of the form: +.INDENT 7.0 +.INDENT 3.5 .sp -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. +.nf +.ft C +{ atype: <expression> } +.ft P +.fi +.UNINDENT +.UNINDENT .sp -By default, \fBmongos\fP assumes that the database specified to the -\fI\-\-db\fP argument holds the user\(aqs credentials, unless you -specify \fI\-\-authenticationDatabase\fP\&. +For authentication operations, the option can also take a document of +the form: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +{ atype: <expression>, "param.db": <database> } +.ft P +.fi +.UNINDENT +.UNINDENT .sp -See \fBuserSource\fP, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The \fBaudit system\fP is +available only in \fI\%MongoDB Enterprise\fP\&. .UNINDENT +.UNINDENT +.UNINDENT +.SS Additional Options .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 MongoDB Enterprise, -\fBmongos\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. +.B \-\-ipv6 +Enables IPv6 support, which allows \fBmongos\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongos\fP, disable IPv6 support by default. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-jsonp +Permits \fIJSONP\fP access via an HTTP interface. Consider the +security implications of allowing this activity before enabling this +option. If the HTTP interface is disabled, the \fI\%\-\-jsonp\fP also +enables the HTTP interface. .sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication -for more information about Kerberos authentication. +\fBSEE ALSO:\fP +.INDENT 7.0 +.INDENT 3.5 +\fI\%\-\-httpinterface\fP +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-noscripting +Disables the scripting engine. .UNINDENT .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongosniff.1 b/debian/mongosniff.1 index 71bb9211706..2f9b72e4e5a 100644 --- a/debian/mongosniff.1 +++ b/debian/mongosniff.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOSNIFF" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOSNIFF" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongosniff \- MongoDB +mongosniff \- MongoDB Protocol Introspection Utility . .nr rst2man-indent-level 0 . @@ -77,21 +77,20 @@ wire protocol. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBmongosniff\fP options and usage. .UNINDENT .INDENT 0.0 .TP .B \-\-forward <host><:port> Declares a host to forward all parsed requests that the -\fBmongosniff\fP intercepts to another \fBmongod\fP -instance and issue those operations on that database instance. +\fBmongosniff\fP intercepts to another \fBmongod\fP instance +and issue those operations on that database instance. .sp -Specify the target host name and port in the \fB<host><:port>\fP -format. +Specify the target host name and port in the \fB<host><:port>\fP format. .sp -To connect to a replica set, you can specify the replica set seed -name, and a seed list of set members, in the following format: +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 @@ -105,33 +104,32 @@ name, and a seed list of set members, in the following format: .UNINDENT .INDENT 0.0 .TP -.B \-\-source <NET [interface]>, <FILE [filename]>, <DIAGLOG [filename]> -Specifies source material to inspect. Use \fB\-\-source NET -[interface]\fP to inspect traffic from a network interface -(e.g. \fBeth0\fP or \fBlo\fP\&.) Use \fB\-\-source FILE [filename]\fP to -read captured packets in \fIpcap\fP format. -.sp -You may use the \fB\-\-source DIAGLOG [filename]\fP option to read -the output files produced by the \fI\-\-diaglog\fP +.B \-\-source <NET [interface]> +Specifies source material to inspect. Use \fB\-\-source NET [interface]\fP +to inspect traffic from a network interface (e.g. \fBeth0\fP or \fBlo\fP\&.) +Use \fB\-\-source FILE [filename]\fP to read captured packets in +\fIpcap\fP format. +.sp +You may use the \fB\-\-source DIAGLOG [filename]\fP option to read the +output files produced by the \fI\-\-diaglog\fP option. .UNINDENT .INDENT 0.0 .TP .B \-\-objcheck -Modifies the behavior to \fIonly\fP display invalid BSON objects and -nothing else. Use this option for troubleshooting driver -development. This option has some performance impact on the -performance of \fBmongosniff\fP\&. +Displays invalid BSON objects only and nothing else. Use this option for +troubleshooting driver development. This option has some performance +impact on the performance of \fBmongosniff\fP\&. .UNINDENT .INDENT 0.0 .TP .B <port> Specifies alternate ports to sniff for traffic. By default, -\fBmongosniff\fP watches for MongoDB traffic on port 27017. Append +\fBmongosniff\fP watches for MongoDB traffic on port \fB27017\fP\&. Append multiple port numbers to the end of \fBmongosniff\fP to monitor traffic on multiple ports. .UNINDENT -.SH USAGE +.SH USE .sp Use the following command to connect to a \fBmongod\fP or \fBmongos\fP running on port 27017 \fIand\fP 27018 on the localhost @@ -214,6 +212,6 @@ must run \fBscons clean\fP before you can build \fBmongosniff\fP\&. .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongostat.1 b/debian/mongostat.1 index 97f0c92337c..d4a4616b386 100644 --- a/debian/mongostat.1 +++ b/debian/mongostat.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOSTAT" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOSTAT" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongostat \- MongoDB +mongostat \- MongoDB Use Statistics . .nr rst2man-indent-level 0 . @@ -77,33 +77,30 @@ instance. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBmongostat\fP options and usage. .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\&.) +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 \-\-version -Returns the version of the \fBmongostat\fP utility. +Returns the \fBmongostat\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port> -Specifies a resolvable hostname for the \fBmongod\fP from which you -want to export data. By default \fBmongostat\fP attempts to connect -to a MongoDB instance running on the localhost port number \fB27017\fP\&. +.B \-\-host <hostname><:port>, \-h +Specifies a resolvable hostname for the \fBmongod\fP to which to +connect. By default \fBmongostat\fP attempts to connect to a MongoDB instance +running on the localhost on port number \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, you can specify the replica set seed -name, and a seed list of set members, in the following format: +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 @@ -114,76 +111,138 @@ name, and a seed list of set members, in the following format: .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 <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 \fImongostat \-\-host\fP command. +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 that allows \fBmongostat\fP to connect -to the MongoDB instance using an IPv6 network. All MongoDB programs -and processes, including \fBmongostat\fP, disable IPv6 -support by default. +Enables IPv6 support, which allows \fBmongostat\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongostat\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 mongostat\&. +New in version 2.6. .sp -\fBNOTE:\fP -.INDENT 7.0 -.INDENT 3.5 -SSL support in mongostat is not compiled into the default -distribution of MongoDB. See -http://docs.mongodb.org/manual/tutorial/configure\-ssl for more information on SSL -and MongoDB. +Enables connection to a \fBmongod\fP or \fBmongos\fP that has +SSL support enabled. .sp -Additionally, mongostat does not support connections to -\fBmongod\fP instances that require client certificate -validation. +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 <filename> +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 <filename> +New in version 2.6. + .sp -Allows \fBmongostat\fP to connect to \fBmongod\fP -instance over an SSL connection. +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 \-\-username <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance, if your -database requires authentication. Use in conjunction with the -\fImongostat \-\-password\fP option to supply a password. +.B \-\-sslPEMKeyPassword <value> +New in version 2.6. + .sp -\fBIMPORTANT:\fP -.INDENT 7.0 -.INDENT 3.5 -This user must have sufficient credentials to run -the \fBserverStatus\fP command, which is the -\fBclusterAdmin\fP role. See -http://docs.mongodb.org/manual/reference/user\-privileges and -http://docs.mongodb.org/manual/reference/privilege\-documents for more information. +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, \fBmongostat\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, \fBmongostat\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 <filename> +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 \-\-password <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. Use -in conjunction with the \fImongostat \-\-username\fP option to -supply a username. +.B \-\-sslFIPSMode +New in version 2.6. + +.sp +Directs \fBmongostat\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 -If you specify a \fI\-\-username\fP, and do do not pass an -argument to \fI\-\-password\fP, \fBmongostat\fP will prompt -for a password interactively. If you do not specify a password on -the command line, \fI\-\-password\fP must be the last argument -specified. +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 <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 <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 @@ -191,17 +250,10 @@ specified. New in version 2.4. .sp -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. -.sp -By default, \fBmongostat\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, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +Specifies the database that holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongostat\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 @@ -209,13 +261,11 @@ delegated authentication in MongoDB. 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, -\fBmongostat\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. -.sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +Specifies the authentication mechanism. By default, the authentication +mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response +authentication mechanism. In MongoDB Enterprise, \fBmongostat\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 @@ -225,14 +275,13 @@ Disables the output of column or field names. .UNINDENT .INDENT 0.0 .TP -.B \-\-rowcount <number>, \-n <number> +.B \-\-rowcount <number>, \-n Controls the number of rows to output. Use in conjunction with the \fBsleeptime\fP argument to control the duration of a \fBmongostat\fP operation. .sp -Unless \fI\%--rowcount\fP is specified, \fBmongostat\fP -will return an infinite number -of rows (e.g. value of \fB0\fP\&.) +Unless \fI\%\-\-rowcount\fP is specified, \fBmongostat\fP +will return an infinite number of rows (e.g. value of \fB0\fP\&.) .UNINDENT .INDENT 0.0 .TP @@ -243,16 +292,20 @@ rather than a raw database connection. .INDENT 0.0 .TP .B \-\-discover -With this option \fBmongostat\fP discovers and reports on -statistics from all members of a \fIreplica set\fP or -\fIsharded cluster\fP\&. When connected to any member of a replica -set, \fI\%--discover\fP all non\-\fIhidden members\fP of the replica set. When connected to a \fBmongos\fP, -\fBmongostat\fP will return data from all \fIshards\fP in the cluster. If a replica set provides a shard in the -sharded cluster, \fBmongostat\fP will report on non\-hidden -members of that replica set. +Discovers and reports on statistics from all members of a \fIreplica +set\fP or \fIsharded cluster\fP\&. When connected to any member of a +replica set, \fI\%\-\-discover\fP all non\-\fIhidden members\fP of the replica set. When connected to a \fBmongos\fP, +\fBmongostat\fP will return data from all \fIshards\fP in +the cluster. If a replica set provides a shard in the sharded cluster, +\fBmongostat\fP will report on non\-hidden members of that replica +set. .sp The \fImongostat \-\-host\fP option is not required but potentially useful in this case. +.sp +Changed in version 2.6: When running with \fI\%\-\-discover\fP, \fBmongostat\fP now +respects :option:\-\-rowcount\(ga. + .UNINDENT .INDENT 0.0 .TP @@ -328,13 +381,19 @@ data size at the time of the last \fBmongostat\fP call. .INDENT 0.0 .TP .B size -The amount of (virtual) memory in megabytes used by the process at +The amount of virtual memory in megabytes used by the process at +the time of the last \fBmongostat\fP call. +.UNINDENT +.INDENT 0.0 +.TP +.B non\-mapped +The total amount of virtual memory excluding all mapped memory at the time of the last \fBmongostat\fP call. .UNINDENT .INDENT 0.0 .TP .B res -The amount of (resident) memory in megabytes used by the process at +The amount of resident memory in megabytes used by the process at the time of the last \fBmongostat\fP call. .UNINDENT .INDENT 0.0 @@ -547,6 +606,6 @@ mongostat \-\-discover .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . diff --git a/debian/mongotop.1 b/debian/mongotop.1 index 20208e67746..d6646d51470 100644 --- a/debian/mongotop.1 +++ b/debian/mongotop.1 @@ -1,8 +1,8 @@ .\" Man page generated from reStructuredText. . -.TH "MONGOTOP" "1" "October 03, 2013" "2.4" "mongodb-manual" +.TH "MONGOTOP" "1" "March 18, 2014" "2.6" "mongodb-manual" .SH NAME -mongotop \- MongoDB +mongotop \- MongoDB Activity Monitor . .nr rst2man-indent-level 0 . @@ -71,34 +71,46 @@ see \fBmongostat\fP\&. .UNINDENT .INDENT 0.0 .TP -.B \-\-help -Returns a basic help and usage text. +.B \-\-help, \-h +Returns information on \fBmongotop\fP options and usage. .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\&.) +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 \fBmongotop\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 -Print the version of the \fBmongotop\fP utility and exit. +Returns the \fBmongotop\fP release number. .UNINDENT .INDENT 0.0 .TP -.B \-\-host <hostname><:port> -Specifies a resolvable hostname for the \fBmongod\fP from which you -want to export data. By default \fBmongotop\fP attempts to -connect to a MongoDB process running on the localhost port number -\fB27017\fP\&. -.sp -Optionally, specify a port number to connect a MongoDB instance -running on a port other than \fB27017\fP\&. +.B \-\-host <hostname><:port>, \-h +Specifies a resolvable hostname for the \fBmongod\fP to which to +connect. By default \fBmongotop\fP attempts to connect to a MongoDB instance +running on the localhost on port number \fB27017\fP\&. .sp -To connect to a replica set, you can specify the replica set seed -name, and a seed list of set members, in the following format: +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 @@ -109,92 +121,176 @@ name, and a seed list of set members, in the following format: .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 <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 \fImongotop \-\-host\fP command. +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 that allows \fBmongotop\fP to connect -to the MongoDB instance using an IPv6 network. All MongoDB programs -and processes, including \fBmongotop\fP, disable IPv6 -support by default. +Enables IPv6 support, which allows \fBmongotop\fP to connect to the MongoDB +instance using an IPv6 network. All MongoDB programs and processes, +including \fBmongotop\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 \-\-username <username>, \-u <username> -Specifies a username to authenticate to the MongoDB instance, if -your database requires authentication. Use in conjunction with the -\fImongotop\fP option to supply a -password. +.B \-\-sslCAFile <filename> +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 \-\-password <password>, \-p <password> -Specifies a password to authenticate to the MongoDB instance. Use -in conjunction with the \fI\-\-username\fP -option to supply a username. +.B \-\-sslPEMKeyFile <filename> +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 -If you specify a \fI\-\-username\fP and do -not pass an argument to \fI\-\-password\fP, \fBmongotop\fP -will prompt for a password interactively. If you do not specify a -password on the command line, \fI\-\-password\fP must be the last -argument specified. +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 \-\-authenticationDatabase <dbname> -New in version 2.4. +.B \-\-sslPEMKeyPassword <value> +New in version 2.6. .sp -Specifies the database that holds the user\(aqs (e.g -\fI\-\-username\fP) credentials. +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, \fBmongotop\fP will +redact the password from all logging and reporting output. .sp -By default, \fBmongotop\fP assumes that the database specified to the -\fI\-\-db\fP argument holds the user\(aqs credentials, unless you -specify \fI\-\-authenticationDatabase\fP\&. +If the private key in the PEM file is encrypted and you do not specify +\fI\%\-\-sslPEMKeyPassword\fP, \fBmongotop\fP will prompt for a passphrase. +See \fIssl\-certificate\-password\fP\&. .sp -See \fBuserSource\fP, -http://docs.mongodb.org/manual/reference/privilege\-documents and -http://docs.mongodb.org/manual/reference/user\-privileges for more information about -delegated authentication in MongoDB. +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 \-\-authenticationMechanism <name> +.B \-\-sslCRLFile <filename> +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 \fBmongotop\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 <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 <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 <dbname> 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, -\fBmongotop\fP also includes support for \fBGSSAPI\fP to handle -Kerberos authentication. +Specifies the database that holds the user\(aqs credentials. +If you do not specify an authentication database, \fBmongotop\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 <name> +New in version 2.4. + .sp -See http://docs.mongodb.org/manual/tutorial/control\-access\-to\-mongodb\-with\-kerberos\-authentication +Specifies the authentication mechanism. By default, the authentication +mechanism is \fBMONGODB\-CR\fP, which is the MongoDB challenge/response +authentication mechanism. In MongoDB Enterprise, \fBmongotop\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 \-\-locks -New in version 2.2. - -.sp -Toggles the mode of \fBmongotop\fP to report on use of -per\-database \fIlocks\fP\&. These data are useful for -measuring concurrent operations and lock percentage. +Toggles the mode of \fBmongotop\fP to report on use of per\-database +\fIlocks\fP\&. These data are useful for measuring concurrent +operations and lock percentage. .UNINDENT .INDENT 0.0 .TP .B <sleeptime> The final argument is the length of time, in seconds, that -\fBmongotop\fP waits in between calls. By default -\fBmongotop\fP returns data every second. +\fBmongotop\fP waits in between calls. By default \fBmongotop\fP returns +data every second. .UNINDENT .SH FIELDS .sp @@ -202,7 +298,7 @@ The final argument is the length of time, in seconds, that (ms.) .sp \fBmongotop\fP only reports active namespaces or databases, -depending on the \fI\%--locks\fP option. If you don\(aqt see a database +depending on the \fI\%\-\-locks\fP option. If you don\(aqt see a database or collection, it has received no recent activity. You can issue a simple operation in the \fBmongo\fP shell to generate activity to affect the output of \fBmongotop\fP\&. @@ -212,7 +308,7 @@ affect the output of \fBmongotop\fP\&. Contains the database namespace, which combines the database name and collection. .sp -Changed in version 2.2: If you use the \fI\%--locks\fP, the \fBns\fP field does not +Changed in version 2.2: If you use the \fI\%\-\-locks\fP, the \fBns\fP field does not appear in the \fBmongotop\fP output. .UNINDENT @@ -226,7 +322,7 @@ Contains the name of the database. The database named \fB\&.\fP refers to the global lock, rather than a specific database. .sp This field does not appear unless you have invoked -\fBmongotop\fP with the \fI\%--locks\fP option. +\fBmongotop\fP with the \fI\%\-\-locks\fP option. .UNINDENT .INDENT 0.0 .TP @@ -333,6 +429,6 @@ connected to: 127.0.0.1 .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2013, MongoDB, Inc. +2011-2014, MongoDB, Inc. .\" Generated by docutils manpage writer. . |