Skip to content

Commit 65e3eb2

Browse files
(DOCSP-32344): [Revamp] /docs/manual/tutorial/backup-and-restore-tools/ (#4918) (#5011)
* (DOCSP-32344): [Revamp] /docs/manual/tutorial/backup-and-restore-tools/ * More places to add Atlas * fix formatting errors * more typo fixes * Apply suggestions from code review * edits from review * more little fixes * second copy review --------- Co-authored-by: Melissa Mahoney <[email protected]>
1 parent 273c994 commit 65e3eb2

File tree

3 files changed

+55
-50
lines changed

3 files changed

+55
-50
lines changed

source/includes/extracts-export-tools-performance-considerations-base.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ content: |
1414
- Label files so that you can identify the contents of the
1515
backup as well as the point in time that the backup reflects.
1616
17-
- Use an alternative backup strategy such as :doc:`Filesystem
18-
Snapshots </tutorial/backup-with-filesystem-snapshots>` or
19-
:mms-docs:`MongoDB Cloud Manager </tutorial/nav/backup-use>` if the
20-
performance impact of {{out_tool}} and {{in_tool}} is unacceptable
17+
- Use an alternative backup strategy such as
18+
:doc:`Filesystem Snapshots </tutorial/backup-with-filesystem-snapshots>`
19+
or :atlas:`Cloud Backups in MongoDB Atlas </backup/cloud-backup/overview>`
20+
if the performance impact of {{out_tool}} and {{in_tool}} is unacceptable
2121
for your use case.
2222
2323
{{mongoDumpBullet}}
@@ -28,10 +28,10 @@ content: |
2828
.. seealso::
2929
3030
:doc:`/core/backups` and
31-
:mms-docs:`MongoDB Cloud Manager Backup documentation
32-
</tutorial/nav/backup-use/>` for more information on backing up
33-
MongoDB instances. Additionally, consider the following reference
34-
documentation for the MongoDB Database Tools:
31+
:atlas:`MongoDB Atlas Cloud Backups </backup/cloud-backup/overview/>`
32+
for more information on backing up MongoDB instances. Additionally,
33+
consider the following reference documentation for the MongoDB Database
34+
Tools:
3535
3636
- :binary:`~bin.mongoexport`
3737
- :binary:`~bin.mongoimport`

source/includes/extracts-export-tools-performance-considerations.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ replacement:
77
in_tool: ":binary:`mongorestore`"
88
mongoDumpBullet: |
99
- Use :option:`--oplog <mongodump --oplog>` to capture incoming write operations during
10-
the {{out_tool}} operation to ensure that the backups reflect
10+
the :binary:`mongodump` operation to ensure that the backups reflect
1111
a consistent data state.
1212
---
1313
ref: tools-performance-considerations-export-import

source/tutorial/backup-and-restore-tools.txt

Lines changed: 46 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -9,58 +9,46 @@ Back Up and Restore with MongoDB Tools
99
.. contents:: On this page
1010
:local:
1111
:backlinks: none
12-
:depth: 1
12+
:depth: 2
1313
:class: singlecol
1414

1515
This tutorial describes the process for creating backups and restoring data
16-
using the utilities provided with MongoDB.
16+
using the command-line utilities :binary:`~bin.mongorestore` and :binary:`~bin.mongodump`
17+
provided with MongoDB.
1718

18-
.. note:: MongoDB Atlas
19+
To restore a backup of your self-hosted deployment
20+
to a managed `{+atlas+} deployment
21+
<https://www.mongodb.com/docs/atlas?tck=docs_server>`__,
22+
see :atlas:`Seed with mongorestore </import/mongorestore/>`.
1923

20-
MongoDB Atlas uses :atlas:`Cloud Backups </backup/cloud-backup/overview>`,
21-
which provide localized backup storage using the native snapshot
22-
functionality of the cluster's cloud service provider.
24+
For a fully-managed backup method, use :atlas:`Cloud Backups </backup/cloud-backup/overview>`
25+
in MongoDB Atlas, which provide localized backup storage using the native snapshot
26+
functionality of the cluster's cloud service provider.
2327

2428
Considerations
2529
--------------
2630

31+
.. _binary-bson-dumps:
32+
2733
Deployments
2834
~~~~~~~~~~~
2935

30-
The :binary:`~bin.mongodump` and :binary:`~bin.mongorestore` utilities
31-
work with :doc:`BSON </reference/bson-types>` data dumps, and are
32-
useful for creating backups of small deployments. For resilient and
33-
non-disruptive backups, use a file system or block-level disk snapshot
34-
function, such as the methods described in the :doc:`/core/backups`
35-
document.
36+
The :binary:`~bin.mongorestore` and :binary:`~bin.mongodump` utilities
37+
work with :ref:`BSON <bson-types>` data dumps, and are
38+
useful for creating backups of small deployments. For resilient and
39+
non-disruptive backups, use :doc:`file system snapshots </tutorial/backup-with-filesystem-snapshots>`
40+
or block-level disk snapshots with
41+
:atlas:`Cloud Backups </backup/cloud-backup/overview>` from {+atlas+}.
3642

37-
.. note::
43+
.. note:: Back Up Sharded Clusters with {+atlas+}
3844

3945
.. include:: /includes/extracts/sharded-clusters-backup-restore-mongodump-mongorestore-restriction.rst
4046

41-
Performance Considerations
42-
~~~~~~~~~~~~~~~~~~~~~~~~~~
47+
Performance Impacts
48+
~~~~~~~~~~~~~~~~~~~
4349

4450
.. include:: /includes/extracts/tools-performance-considerations-dump-restore.rst
4551

46-
.. _binary-bson-dumps:
47-
48-
Binary BSON Dumps
49-
-----------------
50-
51-
The :binary:`~bin.mongorestore` and :binary:`~bin.mongodump` utilities work with
52-
:doc:`BSON </reference/bson-types>` data dumps, and are useful for creating
53-
backups of small deployments. For resilient and non-disruptive backups, use a
54-
file system or block-level disk snapshot function, such as the methods
55-
described in the :doc:`/core/backups` document.
56-
57-
Use these tools for backups if other backup methods, such as
58-
|mms-home| or
59-
:doc:`file system snapshots </tutorial/backup-with-filesystem-snapshots>`
60-
are unavailable.
61-
62-
.. include:: /includes/replacement-mms.rst
63-
6452
.. _backup-mongodump:
6553
.. _backup-and-restore-tools:
6654

@@ -70,7 +58,7 @@ Procedures
7058
Back Up a Database with ``mongodump``
7159
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7260

73-
.. note::
61+
.. note:: Back Up Sharded Clusters with {+atlas+}
7462

7563
.. include:: /includes/extracts/sharded-clusters-backup-restore-mongodump-mongorestore-restriction.rst
7664

@@ -106,13 +94,30 @@ use the following command:
10694

10795
mongodump
10896

109-
You can also specify the :option:`--host <mongodump.--host>` and
110-
:option:`--port <mongodump.--port>` of the MongoDB instance that the
111-
:binary:`~bin.mongodump` should connect to. For example:
97+
To specify the host and port of the MongoDB instance, you can either:
11298

113-
.. code-block:: bash
99+
- Specify the hostname and port in the ``--uri`` string, using either an
100+
:ref:`SRV <connections-dns-seedlist>` or
101+
:ref:`standard <connections-standard-connection-string-format>` connection string:
102+
103+
.. code-block:: bash
104+
:copyable: false
105+
106+
mongodump --uri="mongodb+srv://username:[email protected]" <additional_options>
107+
108+
- Specify the hostname and port in the ``--host`` string:
109+
110+
.. code-block:: bash
111+
:copyable: false
112+
113+
mongodump --host="mongodb0.example.com:27017" <additional_options>
114+
115+
- Specify the hostname and port in the ``--host`` and ``--port``:
114116

115-
mongodump --host=mongodb.example.net --port=27017
117+
.. code-block:: bash
118+
:copyable: false
119+
120+
mongodump --host="mongodb0.example.com" --port=27017 <additional_options>
116121

117122
:binary:`~bin.mongodump` will write :term:`BSON` files that hold a copy of
118123
data accessible via the :binary:`~bin.mongod` listening on port ``27017`` of
@@ -185,7 +190,7 @@ and password credentials to specify database authentication.
185190
Restore a Database with ``mongorestore``
186191
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187192

188-
.. note::
193+
.. note:: Back Up Sharded Clusters with {+atlas+}
189194

190195
.. include:: /includes/extracts/sharded-clusters-backup-restore-mongodump-mongorestore-restriction.rst
191196

@@ -222,7 +227,7 @@ To use :binary:`~bin.mongorestore` to connect to an active
222227
.. code-block:: bash
223228
:copyable: false
224229

225-
mongorestore --port=<port number> <path to the backup>
230+
mongorestore --uri <connection string> <path to the backup>
226231

227232

228233
Consider the following example:

0 commit comments

Comments
 (0)