diff options
Diffstat (limited to 'debian/bsondump.1')
| -rw-r--r-- | debian/bsondump.1 | 102 |
1 files changed, 64 insertions, 38 deletions
diff --git a/debian/bsondump.1 b/debian/bsondump.1 index 892b46c92c2..74f091ea918 100644 --- a/debian/bsondump.1 +++ b/debian/bsondump.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "BSONDUMP" "1" "January 30, 2015" "3.0" "mongodb-manual" +.TH "BSONDUMP" "1" "Jun 21, 2018" "4.0" "mongodb-manual" .SH NAME bsondump \- MongoDB BSON Utility . @@ -30,22 +30,42 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. +.SS On this page +.INDENT 0.0 +.IP \(bu 2 +\fI\%Synopsis\fP +.IP \(bu 2 +\fI\%Options\fP +.IP \(bu 2 +\fI\%Use\fP +.UNINDENT +.INDENT 0.0 +.INDENT 3.5 +.IP "Mac OSX Sierra and Go 1.6 Incompatibility" +.sp +Users running on Mac OSX Sierra require the 3.2.10 or newer version +of \fI\%bsondump\fP\&. +.UNINDENT +.UNINDENT .SH SYNOPSIS .sp -The \fBbsondump\fP converts \fIBSON\fP files into human\-readable -formats, including \fIJSON\fP\&. For example, \fBbsondump\fP is useful +The \fI\%bsondump\fP converts BSON files into human\-readable +formats, including JSON\&. For example, \fI\%bsondump\fP is useful for reading the output files generated by \fBmongodump\fP\&. .sp +Run \fI\%bsondump\fP from the system command line, not the \fBmongo\fP shell. +.sp \fBIMPORTANT:\fP .INDENT 0.0 .INDENT 3.5 -\fBbsondump\fP is a diagnostic tool for inspecting +\fI\%bsondump\fP is a diagnostic tool for inspecting BSON files, not a tool for data ingestion or other application use. .UNINDENT .UNINDENT .SH OPTIONS .sp -Changed in version 3.0.0: \fBbsondump\fP removed the \fB\-\-filter\fP option. +Changed in version 3.0.0: \fI\%bsondump\fP removed the \fB\-\-filter\fP, \fB\-\-dbpath\fP and the +\fB\-\-noobjcheck\fP options. .INDENT 0.0 .TP @@ -53,10 +73,6 @@ Changed in version 3.0.0: \fBbsondump\fP removed the \fB\-\-filter\fP option. .UNINDENT .INDENT 0.0 .TP -.B bsondump -.UNINDENT -.INDENT 0.0 -.TP .B \-\-help Returns information on the options and use of \fBbsondump\fP\&. .UNINDENT @@ -70,13 +86,13 @@ including the option multiple times, (e.g. \fB\-vvvvv\fP\&.) .INDENT 0.0 .TP .B \-\-quiet -Runs the \fBbsondump\fP in a quiet mode that attempts to limit the amount +Runs \fBbsondump\fP in a quiet mode that attempts to limit the amount of output. .sp This option suppresses: .INDENT 7.0 .IP \(bu 2 -output from \fIdatabase commands\fP +output from database commands .IP \(bu 2 replication activity .IP \(bu 2 @@ -93,31 +109,16 @@ Returns the \fBbsondump\fP release number. .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\&. +Validates each BSON object before outputting it in JSON +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 -database. - -.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. +\fI\%\-\-objcheck\fP can have a small impact on performance. .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. +“JSON” (the default) to a debugging format. .UNINDENT .INDENT 0.0 .TP @@ -129,29 +130,54 @@ Outputs documents in a pretty\-printed format JSON. .UNINDENT .INDENT 0.0 .TP +.B \-\-bsonFile +New in version 3.4. + +.sp +Specifies a path to a BSON file to dump to JSON. \fI\%\-\-bsonFile\fP is +an alternative to the positional \fI\%<bsonFilename>\fP option. +.sp +By default, \fBbsondump\fP reads from standard input. +.UNINDENT +.INDENT 0.0 +.TP .B <bsonFilename> The final argument to \fBbsondump\fP is a document containing -\fIBSON\fP\&. This data is typically generated by -\fBbsondump\fP or by MongoDB in a \fIrollback\fP operation. +BSON\&. This data is typically generated by +\fBbsondump\fP or by MongoDB in a rollback operation. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-outFile +New in version 3.4. + +.sp +Specifies the path of the file to which \fBbsondump\fP should write +its output JSON data. +.sp +By default, \fBbsondump\fP writes to standard output. .UNINDENT .SH USE .sp -By default, \fBbsondump\fP outputs data to standard output. To -create corresponding \fIJSON\fP files, you will need to use the -shell redirect. See the following command: +Changed in version 3.4. + +.sp +By default, \fI\%bsondump\fP outputs data to standard output. To +create corresponding JSON files, you can use the +\fI\%\-\-outFile\fP option: .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -bsondump collection.bson > collection.json +bsondump \-\-outFile collection.json collection.bson .ft P .fi .UNINDENT .UNINDENT .sp Use the following command (at the system shell) to produce debugging -output for a \fIBSON\fP file: +output for a BSON file: .INDENT 0.0 .INDENT 3.5 .sp @@ -165,6 +191,6 @@ bsondump \-\-type=debug collection.bson .SH AUTHOR MongoDB Documentation Project .SH COPYRIGHT -2011-2015 +2008-2018 .\" Generated by docutils manpage writer. . |