Blame SOURCES/bsondump.1

7fe184
.\" Man page generated from reStructuredText.
7fe184
.
7fe184
.TH "BSONDUMP" "1" "January 30, 2015" "3.0" "mongodb-manual"
7fe184
.SH NAME
7fe184
bsondump \- MongoDB BSON Utility
7fe184
.
7fe184
.nr rst2man-indent-level 0
7fe184
.
7fe184
.de1 rstReportMargin
7fe184
\\$1 \\n[an-margin]
7fe184
level \\n[rst2man-indent-level]
7fe184
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
7fe184
-
7fe184
\\n[rst2man-indent0]
7fe184
\\n[rst2man-indent1]
7fe184
\\n[rst2man-indent2]
7fe184
..
7fe184
.de1 INDENT
7fe184
.\" .rstReportMargin pre:
7fe184
. RS \\$1
7fe184
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
7fe184
. nr rst2man-indent-level +1
7fe184
.\" .rstReportMargin post:
7fe184
..
7fe184
.de UNINDENT
7fe184
. RE
7fe184
.\" indent \\n[an-margin]
7fe184
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
7fe184
.nr rst2man-indent-level -1
7fe184
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
7fe184
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
7fe184
..
7fe184
.SH SYNOPSIS
7fe184
.sp
7fe184
The \fBbsondump\fP converts \fIBSON\fP files into human\-readable
7fe184
formats, including \fIJSON\fP\&. For example, \fBbsondump\fP is useful
7fe184
for reading the output files generated by \fBmongodump\fP\&.
7fe184
.sp
7fe184
\fBIMPORTANT:\fP
7fe184
.INDENT 0.0
7fe184
.INDENT 3.5
7fe184
\fBbsondump\fP is a diagnostic tool for inspecting
7fe184
BSON files, not a tool for data ingestion or other application use.
7fe184
.UNINDENT
7fe184
.UNINDENT
7fe184
.SH OPTIONS
7fe184
.sp
7fe184
Changed in version 3.0.0: \fBbsondump\fP removed the \fB\-\-filter\fP option.
7fe184
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B bsondump
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B bsondump
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B \-\-help
7fe184
Returns information on the options and use of \fBbsondump\fP\&.
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B \-\-verbose, \-v
7fe184
Increases the amount of internal reporting returned on standard output
7fe184
or in log files. Increase the verbosity with the \fB\-v\fP form by
7fe184
including the option multiple times, (e.g. \fB\-vvvvv\fP\&.)
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B \-\-quiet
7fe184
Runs the \fBbsondump\fP in a quiet mode that attempts to limit the amount
7fe184
of output.
7fe184
.sp
7fe184
This option suppresses:
7fe184
.INDENT 7.0
7fe184
.IP \(bu 2
7fe184
output from \fIdatabase commands\fP
7fe184
.IP \(bu 2
7fe184
replication activity
7fe184
.IP \(bu 2
7fe184
connection accepted events
7fe184
.IP \(bu 2
7fe184
connection closed events
7fe184
.UNINDENT
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B \-\-version
7fe184
Returns the \fBbsondump\fP release number.
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B \-\-objcheck
7fe184
Validates each \fIBSON\fP object before outputting it in \fIJSON\fP
7fe184
format. By default, \fBbsondump\fP enables \fI\-\-objcheck\fP\&.
7fe184
For objects with a high degree of sub\-document nesting,
7fe184
\fI\-\-objcheck\fP can have a small impact on performance. You can set
7fe184
\fI\-\-noobjcheck\fP to disable object checking.
7fe184
.sp
7fe184
Changed in version 2.4: MongoDB enables \fI\-\-objcheck\fP by default, to prevent any
7fe184
client from inserting malformed or invalid BSON into a MongoDB
7fe184
database.
7fe184
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B \-\-noobjcheck
7fe184
New in version 2.4.
7fe184
7fe184
.sp
7fe184
Disables the default document validation that MongoDB performs on all
7fe184
incoming BSON documents.
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B \-\-type <=json|=debug>
7fe184
Changes the operation of \fBbsondump\fP from outputting
7fe184
"\fIJSON\fP" (the default) to a debugging format.
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B \-\-pretty
7fe184
New in version 3.0.0.
7fe184
7fe184
.sp
7fe184
Outputs documents in a pretty\-printed format JSON.
7fe184
.UNINDENT
7fe184
.INDENT 0.0
7fe184
.TP
7fe184
.B <bsonFilename>
7fe184
The final argument to \fBbsondump\fP is a document containing
7fe184
\fIBSON\fP\&. This data is typically generated by
7fe184
\fBbsondump\fP or by MongoDB in a \fIrollback\fP operation.
7fe184
.UNINDENT
7fe184
.SH USE
7fe184
.sp
7fe184
By default, \fBbsondump\fP outputs data to standard output. To
7fe184
create corresponding \fIJSON\fP files, you will need to use the
7fe184
shell redirect. See the following command:
7fe184
.INDENT 0.0
7fe184
.INDENT 3.5
7fe184
.sp
7fe184
.nf
7fe184
.ft C
7fe184
bsondump collection.bson > collection.json
7fe184
.ft P
7fe184
.fi
7fe184
.UNINDENT
7fe184
.UNINDENT
7fe184
.sp
7fe184
Use the following command (at the system shell) to produce debugging
7fe184
output for a \fIBSON\fP file:
7fe184
.INDENT 0.0
7fe184
.INDENT 3.5
7fe184
.sp
7fe184
.nf
7fe184
.ft C
7fe184
bsondump \-\-type=debug collection.bson
7fe184
.ft P
7fe184
.fi
7fe184
.UNINDENT
7fe184
.UNINDENT
7fe184
.SH AUTHOR
7fe184
MongoDB Documentation Project
7fe184
.SH COPYRIGHT
7fe184
2011-2015
7fe184
.\" Generated by docutils manpage writer.
7fe184
.