bsondump.1

.\" Man page generated from reStructuredText.
.
.TH "BSONDUMP" "1" "January 30, 2015" "3.0" "mongodb-manual"
.SH NAME
bsondump \- MongoDB BSON Utility
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
The \fBbsondump\fP converts \fIBSON\fP files into human\-readable
formats, including \fIJSON\fP\&. For example, \fBbsondump\fP is useful
for reading the output files generated by \fBmongodump\fP\&.
.sp
\fBIMPORTANT:\fP
.INDENT 0.0
.INDENT 3.5
\fBbsondump\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.

.INDENT 0.0
.TP
.B bsondump
.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
.INDENT 0.0
.TP
.B \-\-verbose, \-v
Increases the amount of internal reporting returned on standard output
or in log files. Increase the verbosity with the \fB\-v\fP form by
including the option multiple times, (e.g. \fB\-vvvvv\fP\&.)
.UNINDENT
.INDENT 0.0
.TP
.B \-\-quiet
Runs the \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
.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 \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.
.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.
.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.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-pretty
New in version 3.0.0.

.sp
Outputs documents in a pretty\-printed format JSON.
.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.
.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:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bsondump collection.bson > collection.json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Use the following command (at the system shell) to produce debugging
output for a \fIBSON\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
bsondump \-\-type=debug collection.bson
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
MongoDB Documentation Project
.SH COPYRIGHT
2011-2015
.\" Generated by docutils manpage writer.
.