-
Notifications
You must be signed in to change notification settings - Fork 39
(DOCSP-45308) [c2c] add note on how to verify shard keys #526
(DOCSP-45308) [c2c] add note on how to verify shard keys #526
Conversation
✅ Deploy Preview for docs-cluster-to-cluster-sync ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mdb-ashley
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just left a couple comments for your consideration. Thanks, Elyse!
| Shard Key Comparison | ||
| - To verify the transfer of shard keys to a synced collection, run a query on the ``config.collections`` | ||
| collection to find a document whose ``_id`` value is the namespace of the target collection. | ||
| Compare the ``key`` value of this document in the source and destination clusters. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[question] Should key be monospaced here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am using "key" to refer to the field name in the document, so if _id is monospaced, it feels more consistent to also monospace key. Do you think it would be helpful to emphasize thatkey is a field name? eg
"Compare the
keyfield value..."
Co-authored-by: Ashley Brown <98361885+mdb-ashley@users.noreply.github.com>
Co-authored-by: Felipe Gasper <FGasper@users.noreply.github.com>
* (DOCSP-45308) Edits. * (DOCSP-45308) Verify shard key. * (DOCSP-45308) Edits. * (DOCSP-45308) Condense code example. * (DOCSP-45308) edits. * (DOCSP-45308) Edits. * Update source/reference/verification.txt Co-authored-by: Ashley Brown <98361885+mdb-ashley@users.noreply.github.com> * Update source/reference/verification.txt Co-authored-by: Felipe Gasper <FGasper@users.noreply.github.com> --------- Co-authored-by: Ashley Brown <98361885+mdb-ashley@users.noreply.github.com> Co-authored-by: Felipe Gasper <FGasper@users.noreply.github.com>
* (DOCSP-45308) Edits. * (DOCSP-45308) Verify shard key. * (DOCSP-45308) Edits. * (DOCSP-45308) Condense code example. * (DOCSP-45308) edits. * (DOCSP-45308) Edits. * Update source/reference/verification.txt * Update source/reference/verification.txt --------- Co-authored-by: Ashley Brown <98361885+mdb-ashley@users.noreply.github.com> Co-authored-by: Felipe Gasper <FGasper@users.noreply.github.com>
DESCRIPTION
currently, we don't document how to verify that shard keys are migrated during a sync. that said, it is important that users do this, so it'd be great to add this note.
From Felipe Gasper:
STAGING
https://deploy-preview-526--docs-cluster-to-cluster-sync.netlify.app/reference/verification/
JIRA
DOCSP-45308
SELF-REVIEW CHECKLIST
See the taxonomy tagging instructions and this example PR
EXTERNAL REVIEW REQUIREMENTS
What's expected of an external reviewer?