Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

DOCSP-48242-mongosync-metadata-post-sync #651

Merged
merged 4 commits into from
Mar 13, 2025
Merged

DOCSP-48242-mongosync-metadata-post-sync #651

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a515cb
DOCSP-48242-mongosync-metadata-post-sync
amalhotra-mdb Mar 12, 2025
10e7994
capitalize heading
amalhotra-mdb Mar 12, 2025
3aea993
reviewer updates
amalhotra-mdb Mar 12, 2025
dc8759a
clarification
amalhotra-mdb Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions source/reference/mongosync/mongosync-behavior.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,18 @@ Rolling Index Builds

.. include:: /includes/rolling-build-limitation.rst

``mongosync`` Metadata
~~~~~~~~~~~~~~~~~~~~~~

``mongosync`` stores its metadata in a database during migration. The metadata
database may be named any of the following:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[verb suggestion/question]

I think we should update this to use a different modal verb. Genereally, we use "may" in the docs to indicate permission: https://www.mongodb.com/docs/meta/style-guide/writing/use-effective-verbs/#use-modal-verbs-accurately

Would it make sense to update to "The metadata database will be named one of the following:"? I'm not sure if this is technically correct, though. Are we saying that it will be just one of these, or could there be multiple databases?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your review @jmd-mongo ! I confirmed with @FGasper that there can be multiple databases; for example, mongosync’s embedded verifier stores its metadata separately from the rest of mongosync. I updated the PR accordingly, LMK if the changes look ok to you!


- ``mongosync_reserved_for_internal_use``
- Anything beginning with ``mongosync_internal_``
- Anything beginning with ``mongosync_reserved_for_verification_``

You should drop any metadata databases after a successful migration.

Destination Clusters
--------------------

Expand Down