11.. _bsondump:
22
3+ ========
4+ bsondump
5+ ========
6+
37.. default-domain:: mongodb
48
59.. binary:: bsondump
610
711.. program:: bsondump
812
9- ============
10- ``bsondump``
11- ============
12-
1313.. contents:: On this page
1414 :local:
1515 :backlinks: none
1616 :depth: 1
1717 :class: singlecol
1818
19+ .. facet::
20+ :name: genre
21+ :values: reference
22+
1923.. |arrow| unicode:: U+27A4
20- .. |tool-binary| replace:: :binary:`~bin. bsondump`
24+ .. |tool-binary| replace:: `` bsondump` `
2125
2226Synopsis
2327--------
2428
25- The :binary:`~bin. bsondump` converts :term:`BSON` files into human-readable
26- formats, including :term:`JSON`. For example, :binary:`~bin. bsondump` is useful
27- for reading the output files generated by :binary:`~bin. mongodump`.
29+ `` bsondump` ` converts :term:`BSON` files into human-readable
30+ formats, including :term:`JSON`. For example, `` bsondump` ` is useful
31+ for reading the output files generated by `` mongodump` `.
2832
2933.. important::
3034
31- :binary:`~bin. bsondump` is a diagnostic tool for inspecting
35+ `` bsondump` ` is a diagnostic tool for inspecting
3236 BSON files, not a tool for data ingestion or other application use.
3337
34- :binary:`~bin. bsondump` uses :manual:`Extended JSON v2.0
38+ `` bsondump` ` uses :manual:`Extended JSON v2.0
3539(Canonical mode) </reference/mongodb-extended-json>`
3640to format its data.
3741
38- .. include:: /includes/extracts/require-cmd-line-bsondump.rst
39-
40- Versioning
41- ~~~~~~~~~~
42-
43- .. include:: /includes/extracts/dbtools-version-single.rst
44-
45- .. note:: Quick links to older documentation
46-
47- - :v4.2:`MongoDB 4.2 bsondump <reference/program/bsondump>`
48- - :v4.0:`MongoDB 4.0 bsondump <reference/program/bsondump>`
49-
50- This documentation is for version ``{+release+}`` of |tool-binary|.
51-
52- Compatibility
53- -------------
54-
55- MongoDB Server Compatibility
56- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57-
58- .. include:: /includes/extracts/dbtools-compatibility-single.rst
59-
60- Platform Support
61- ~~~~~~~~~~~~~~~~
62-
63- |tool-binary| version ``{+release+}`` is supported on the following
64- platforms:
65-
66- .. include:: /includes/fact-platform-support.rst
67-
68- Installation
69- ------------
70-
71- .. include:: /includes/fact-see-install-guide.rst
42+ Run ``bsondump`` from the system command line, not the
43+ :binary:`~bin.mongo` shell.
7244
7345Options
7446-------
7547
7648.. option:: --help
7749
78- Returns information on the options and use of :program:`bsondump`.
79-
50+ Returns information on the options and use of ``bsondump``.
8051
8152.. option:: --verbose, -v
8253
8354 Increases the amount of internal reporting returned on standard output
8455 or in log files. Increase the verbosity with the ``-v`` form by
8556 including the option multiple times, (e.g. ``-vvvvv``.)
8657
87-
8858.. option:: --quiet
8959
90- Runs :program:` bsondump` in a quiet mode that attempts to limit the amount
60+ Runs `` bsondump` ` in a quiet mode that attempts to limit the amount
9161 of output.
9262
9363 This option suppresses:
@@ -100,70 +70,56 @@ Options
10070
10171 - connection closed events
10272
103-
10473.. option:: --version
10574
106- Returns the :program:`bsondump` release number.
107-
75+ Returns the ``bsondump`` release number.
10876
10977.. option:: --objcheck
11078
111- Validates each :term:`BSON` object before outputting it in :term:`JSON`
112- format. By default, :program:` bsondump` enables :option:`--objcheck <bsondump --objcheck>`.
113- For objects with a high degree of sub-document nesting,
114- :option:`--objcheck <bsondump --objcheck>` can have a small impact on performance.
115-
79+ Validates each :term:`BSON` object before outputting it in
80+ :term:`JSON` format. By default, `` bsondump`` enables
81+ ``--objcheck <bsondump --objcheck>``. For objects with a high
82+ degree of sub-document nesting, `` --objcheck <bsondump
83+ --objcheck>`` can have a small impact on performance.
11684
11785.. option:: --type=<json|debug>
11886
119- Changes the operation of :program:`bsondump` from outputting
120- ":term:`JSON`" (the default) to a debugging format.
121-
87+ Changes the operation of ``bsondump`` from outputting
88+ JSON (the default) to a debugging format.
12289
12390.. option:: --pretty
12491
12592 Outputs documents in a pretty-printed format JSON.
12693
127-
12894.. option:: --bsonFile
12995
130- Specifies the path to a :term:` BSON` file to dump to JSON. :option:` --bsonFile` is
131- an alternative to the positional :option:` \<bsonFilename\>` option.
96+ Specifies the path to a BSON file to dump to JSON. `` --bsonFile` ` is
97+ an alternative to the positional `` \<bsonFilename\>` ` option.
13298
133- By default, :program:`bsondump` reads from standard input.
134-
99+ By default, ``bsondump`` reads from standard input.
135100
136101.. option:: <bsonFilename>
137102
138- The final argument to :program:`bsondump` is a document containing
139- :term:`BSON`. This data is typically generated by
140- :program:`bsondump` or by MongoDB in a :term:`rollback` operation.
141-
103+ The final argument to ``bsondump`` is a document containing
104+ BSON. This data is typically generated by
105+ ``bsondump`` or by MongoDB in a :term:`rollback` operation.
142106
143107.. option:: --outFile=<file>
144108
145- Specifies the path of the file to which :program:` bsondump` should write
109+ Specifies the path of the file to which `` bsondump` ` should write
146110 its output JSON data.
147111
148- By default, :program:`bsondump` writes to standard output.
149-
150-
151- Examples
152- --------
153-
154- .. include:: /includes/extracts/require-cmd-line-bsondump.rst
155-
156- By default, :binary:`~bin.bsondump` outputs data to standard output. To
157- create corresponding :term:`JSON` files, you can use the
158- :option:`--outFile <bsondump --outFile>` option:
159-
160- .. code-block:: sh
112+ By default, ``bsondump`` writes to standard output.
161113
162- bsondump --outFile=collection.json collection.bson
114+ Learn More
115+ ----------
163116
164- Use the following command (at the system shell) to produce debugging
165- output for a :term:`BSON` file:
117+ - :ref:`bsondump-compatibility-and-installation`
118+ - :ref:`bsondump-examples`
166119
167- .. code-block:: sh
120+ .. toctree::
121+ :maxdepth: 1
122+ :hidden:
168123
169- bsondump --type=debug collection.bson
124+ Compatibility and Installation </bsondump/bsondump-compatibility-and-installation>
125+ Examples </bsondump/bsondump-examples>
0 commit comments