Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(DOCSP-39188): Clarify that restores can be at most one major version ahead #150

Merged
merged 12 commits into from
May 8, 2024
1 change: 1 addition & 0 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ qe = "Queryable Encryption"
version = "100.9.0"
release = "{+version+}"
pgp-version = "{+version+}"
server-version = "7.0"
pgp-fingerprint = "E162F504A20CDF15827F718D4B7C549A058F8B6B"
rsa-key = "4B7C549A058F8B6B"
pgp-fingerprint-fmt = "E162 F504 A20C DF15 827F 718D 4B7C 549A 058F 8B6B"
Expand Down
9 changes: 6 additions & 3 deletions source/includes/fact-match-dump-restore-versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@ To change your feature compatibility version, see

.. note::

You can restore the BSON files generated from ``mongodump``
into MongoDB deployments running the same or newer version
as the source deployment.
You can restore the BSON files generated from ``mongodump`` into
MongoDB deployments running the same or newer version as the source
deployment. However, restoring files into a newer version deployment
is not the recommended way to upgrade your deployment. To learn how to
upgrade your deployment, see the :manual:`upgrade documentation
</release-notes/{+server-version+}-upgrade>`.

This guarantee does not apply to metadata, archive, or oplog replay
files. If you try to restore these files using different
Expand Down
6 changes: 6 additions & 0 deletions source/includes/mongodump-restore-version-link.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
You can restore the BSON files generated from ``mongodump`` into MongoDB

This comment was marked as resolved.

deployments running the same or newer version as the source deployment.
However, restoring files into a newer version deployment is not the
recommended way to upgrade your deployment. To learn how to upgrade your
deployment, see the :manual:`upgrade documentation
</release-notes/{+server-version+}-upgrade>`.
2 changes: 2 additions & 0 deletions source/mongodump.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ a database's contents. ``mongodump`` can export data from:
``mongodump`` can connect to :binary:`~bin.mongod` and
:binary:`~bin.mongos` instances.

.. include:: /includes/mongodump-restore-version-link.rst

Run ``mongodump`` from the system command line, not the
:binary:`~bin.mongo` shell.

Expand Down
2 changes: 2 additions & 0 deletions source/mongodump/mongodump-behavior.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ to authenticate your ``mongodump`` session and to indicate the database
being dumped. For an example of using a different database for
authentication when using ``mongodump``, see :ref:`mongodump-auth-dump`.

.. _mongodump-matching-server-version:

Restore to Matching Server Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
4 changes: 3 additions & 1 deletion source/mongorestore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ The ``mongorestore`` program loads data from either a binary
database dump created by :binary:`~bin.mongodump` or the standard input
into a :binary:`~bin.mongod` or :binary:`~bin.mongos` instance.

.. include:: /includes/mongodump-restore-version-link.rst

Run ``mongorestore`` from the system command line, not the
:binary:`~bin.mongo` shell.

Expand Down Expand Up @@ -864,4 +866,4 @@ Learn More

Compatibility and Installation </mongorestore/mongorestore-compatibility-and-installation>
Behavior </mongorestore/mongorestore-behavior-access-usage>
Examples </mongorestore/mongorestore-examples>
Examples </mongorestore/mongorestore-examples>