summaryrefslogtreecommitdiff
path: root/debian/bsondump.1
blob: 93b536585f0127fd333f86c8c04aae6b48a64049 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
.\" Man page generated from reStructuredText.
.
.TH "BSONDUMP" "1" "Aug 16, 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\%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 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
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.
.