.\" Man page generated from reStructuredText.
.
.TH "BSONDUMP" "1" "Oct 29, 2019" "4.2" "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
..
.SS On this page
.INDENT 0.0
.IP \(bu 2
\fI\%Synopsis\fP
.IP \(bu 2
\fI\%Availability\fP
.IP \(bu 2
\fI\%Options\fP
.IP \(bu 2
\fI\%Examples\fP
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "macOS Sierra and Go 1.6 Incompatibility"
.sp
Users running on macOS Sierra require the 3.2.10 or newer version
of  \fI\%bsondump\fP\&.
.UNINDENT
.UNINDENT
.SH SYNOPSIS
.sp
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
\fI\%bsondump\fP is a diagnostic tool for inspecting
BSON files, not a tool for data ingestion or other application use.
.UNINDENT
.UNINDENT
.sp
Starting in version 4.2, \fI\%bsondump\fP uses Extended
JSON v2.0 (Canonical mode)
to format its data.
.SH AVAILABILITY
.sp
The \fI\%bsondump\fP tool is part of the MongoDB tools package. Consult the
installation guide for your platform for
instructions on how to install the tools package as part of your
MongoDB installation.
.sp
The tools package is also available from the
\fI\%MongoDB Download Center\fP,
either as a separate \fBtools\fP download, or contained within the
\fBTGZ\fP or \fBZIP\fP downloads, depending on platform. On Windows, the \fBMSI\fP installer includes all tools as part of the default installation.
.INDENT 0.0
.INDENT 3.5
.SH TIP
.sp
If downloading the \fBTGZ\fP or \fBZIP\fP files from the Download
Center, you may want to update your \fBPATH\fP environment
variable to include the directory where you installed these tools.
See the installation guide
for your platform for more information.
.UNINDENT
.UNINDENT
.SH OPTIONS
.sp
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
.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 \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 database commands
.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 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.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-type=<json|debug>
Changes the operation of \fBbsondump\fP from outputting
"JSON" (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 \-\-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
BSON\&. This data is typically generated by
\fBbsondump\fP or by MongoDB in a rollback operation.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-outFile=<file>
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 EXAMPLES
.sp
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 \-\-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 BSON 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
2008-2019
.\" Generated by docutils manpage writer.
.