mirror of
https://github.com/mongodb/mongo.git
synced 2024-11-28 16:24:56 +01:00
129 lines
3.3 KiB
Groff
129 lines
3.3 KiB
Groff
.TH "BSONDUMP" "1" "March 14, 2013" "2.2.3" "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
|
|
..
|
|
.\" Man page generated from reStructuredText.
|
|
.
|
|
.SH SYNOPSIS
|
|
.sp
|
|
The \fI\%bsondump\fP converts \fIBSON\fP files into human\-readable
|
|
formats, including \fIJSON\fP. For example, \fI\%bsondump\fP is useful
|
|
for reading the output files generated by \fBmongodump\fP.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B bsondump
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-help
|
|
Returns a basic help and usage text.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-verbose, \-v
|
|
Increases the amount of internal reporting returned on the command
|
|
line. 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 \-\-version
|
|
Returns the version of the \fI\%bsondump\fP utility.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-objcheck
|
|
Validates each \fIBSON\fP object before outputting it in
|
|
\fIJSON\fP format. By default, \fI\%bsondump\fP enables
|
|
\fI\%--objcheck\fP by default. 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 \fI\%bsondump\fP
|
|
performs on all BSON documents.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-filter \(aq<JSON>\(aq
|
|
Limits the documents that \fI\%bsondump\fP exports to only those
|
|
documents that match the \fIJSON document\fP specified as
|
|
\fB\(aq<JSON>\(aq\fP. Be sure to include the document in single quotes to
|
|
avoid interaction with your system\(aqs shell environment.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-type <=json|=debug>
|
|
Changes the operation of \fI\%bsondump\fP from outputting "\fIJSON\fP" (the
|
|
default) to a debugging format.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B <bsonfilename>
|
|
The final argument to \fI\%bsondump\fP is a document containing
|
|
\fIBSON\fP. This data is typically generated by
|
|
\fBmongodump\fP or by MongoDB in a \fIrollback\fP operation.
|
|
.UNINDENT
|
|
.SH USAGE
|
|
.sp
|
|
By default, \fI\%bsondump\fP outputs data to standard output. To
|
|
create corresponding \fIJSON\fP files, you will need to use the
|
|
shell redirect. See the following command:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
bsondump collection.bson > collection.json
|
|
.ft P
|
|
.fi
|
|
.sp
|
|
Use the following command (at the system shell) to produce debugging
|
|
output for a \fIBSON\fP file:
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
bsondump \-\-type=debug collection.bson
|
|
.ft P
|
|
.fi
|
|
.SH AUTHOR
|
|
MongoDB Documentation Project
|
|
.SH COPYRIGHT
|
|
2011-2013, 10gen, Inc.
|
|
.\" Generated by docutils manpage writer.
|
|
.
|