Blame SOURCES/bsondump.1

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