DOCSP-46854-migrate-pqs-tutorial #580

ltran-mdb2 · 2025-02-03T16:17:20Z

DESCRIPTION

Tutorial for manually migration persistent query settings

STAGING

https://deploy-preview-580--docs-cluster-to-cluster-sync.netlify.app/reference/c2c-migrate-pqs/
https://deploy-preview-580--docs-cluster-to-cluster-sync.netlify.app/reference/cutover-process/#send-a-commit-request-to-mongosync.

JIRA

https://jira.mongodb.org/browse/DOCSP-46854

SELF-REVIEW CHECKLIST

Does each file have 3-5 taxonomy facet tags?
See the taxonomy tagging instructions and this example PR
Is this free of any warnings or errors in the RST?
Is this free of spelling errors?
Is this free of grammatical errors?
Is this free of staging / rendering issues?
Are all the links working?

EXTERNAL REVIEW REQUIREMENTS

What's expected of an external reviewer?

netlify · 2025-02-03T16:17:39Z

✅ Deploy Preview for docs-cluster-to-cluster-sync ready!

Name	Link
🔨 Latest commit	`7e9c326`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-cluster-to-cluster-sync/deploys/67a5012798f6740008ceee6f
😎 Deploy Preview	https://deploy-preview-580--docs-cluster-to-cluster-sync.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

gmiller-mdb · 2025-02-04T15:26:17Z

source/reference/c2c-migrate-pqs.txt

+
+      If your source cluster contains query settings that you do not want to
+      migrate to your destination cluster, remove those settings from your
+      ``querySettings`` array. 
+


Q: Should a command or further explanation of remove be given here, or will the user find this intuitive?

I think there are numerous ways a user could do this depending on their use case but will check with the tech reviewer

You folks probably know the target audience’s level of technical expertise better than I, but I would think removal of an element from a JSON array to be feasible for such users.

FGasper

I’ve left a few notes.

I’m withholding technical approval pending a check from Denis Grebennicov, who knows PQS intimately from the server side.

FGasper · 2025-02-04T18:15:57Z

source/reference/c2c-migrate-pqs.txt

+If your source cluster uses Persistent Query Settings (PQS), you must manually
+migrate those settings to your destination cluster to finalize sync. 
+
+``mongosync`` checks for PQS during the :ref:`cutover process


Nit: It also checks during initialization.

FGasper · 2025-02-04T18:17:47Z

source/reference/c2c-migrate-pqs.txt

+
+      If your source cluster contains query settings that you do not want to
+      migrate to your destination cluster, remove those settings from your
+      ``querySettings`` array. 
+


You folks probably know the target audience’s level of technical expertise better than I, but I would think removal of an element from a JSON array to be feasible for such users.

FGasper · 2025-02-04T18:19:22Z

source/reference/c2c-migrate-pqs.txt

Denis Grebennicov should also review this.

denis631

Thank you for doing this @ltran-mdb2!

LGTM with some minor comments

denis631 · 2025-02-05T09:08:49Z

source/reference/c2c-migrate-pqs.txt

+Steps -----
+


Suggested change

Steps -----

Steps

-----

[nit] I think ----- should be on the newline, as it was rendering correctly in the browser?

denis631 · 2025-02-05T09:09:55Z

source/reference/c2c-migrate-pqs.txt

+      Run the following code block to export your query settings into an array
+      called ``querySettings``:
+
+      .. code-block:: shell
+
+         mongosh --eval
+         'console.log(db.aggregate([{$querySettings:{}}]).toArray())'


[note] will this export query settings into an array? Or will this just print/log all currently set query settings?

Actually this is a good point … @ltran-mdb2 how is the array named querySettings?

When I ran it, it just outputted an array; there’s no name to it.

ah I misinterpreted the JIRA of this ticket. I updated the steps accordingly.

FGasper

LGTM. Thank you!

* DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854 tech edits * DOCSP-46854 tech edits * DOCSP-46854 fixing build (cherry picked from commit 9da7e4e) # Conflicts: # source/reference/cutover-process.txt

ltran-mdb2 · 2025-02-06T19:02:22Z

💔 Some backports could not be created

Status	Branch	Result
❌	v1.11	The branch "v1.11" does not exist
✅	v1.10
✅	v1.9
✅	v1.8

Manual backport

To create the backport manually run:

backport --pr 580

Questions ?

Please refer to the Backport tool documentation

* DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854-migrate-pqs-tutorial * DOCSP-46854 tech edits * DOCSP-46854 tech edits * DOCSP-46854 fixing build (cherry picked from commit 9da7e4e) # Conflicts: # source/reference/cutover-process.txt

DOCSP-46854-migrate-pqs-tutorial

b4f2bb8

ltran-mdb2 added 4 commits February 3, 2025 11:31

DOCSP-46854-migrate-pqs-tutorial

8dbdf05

DOCSP-46854-migrate-pqs-tutorial

23e47cb

DOCSP-46854-migrate-pqs-tutorial

85a2954

DOCSP-46854-migrate-pqs-tutorial

9f104b8

gmiller-mdb suggested changes Feb 4, 2025

View reviewed changes

FGasper reviewed Feb 4, 2025

View reviewed changes

denis631 approved these changes Feb 5, 2025

View reviewed changes

ltran-mdb2 added 2 commits February 5, 2025 15:59

DOCSP-46854 tech edits

50b8f83

DOCSP-46854 tech edits

82a7203

ltran-mdb2 requested a review from FGasper February 5, 2025 21:07

FGasper approved these changes Feb 5, 2025

View reviewed changes

ltran-mdb2 requested a review from gmiller-mdb February 6, 2025 16:54

gmiller-mdb approved these changes Feb 6, 2025

View reviewed changes

ltran-mdb2 and others added 2 commits February 6, 2025 13:31

DOCSP-46854 fixing build

f2a5578

Merge branch 'master' into DOCSP-46854

7e9c326

ltran-mdb2 merged commit 9da7e4e into mongodb:master Feb 6, 2025

ltran-mdb2 mentioned this pull request Feb 6, 2025

DOCSP-46854-migrate-pqs-tutorial-v1.10-backport (580) #595

Merged

ltran-mdb2 mentioned this pull request Feb 6, 2025

DOCSP-46854-migrate-pqs-tutorial-v1.9-backport (580) #596

Merged

ltran-mdb2 mentioned this pull request Feb 6, 2025

DOCSP-46854-migrate-pqs-tutorial-v1.8-backport (580) #597

Merged

DOCSP-46854-migrate-pqs-tutorial #580

DOCSP-46854-migrate-pqs-tutorial #580

Uh oh!

Conversation

ltran-mdb2 commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIPTION

STAGING

JIRA

SELF-REVIEW CHECKLIST

EXTERNAL REVIEW REQUIREMENTS

Uh oh!

netlify bot commented Feb 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-cluster-to-cluster-sync ready!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FGasper left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

denis631 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FGasper left a comment

Choose a reason for hiding this comment

Uh oh!

ltran-mdb2 commented Feb 6, 2025

💔 Some backports could not be created

Manual backport

Questions ?

Uh oh!

Uh oh!

ltran-mdb2 commented Feb 3, 2025 •

edited

Loading

netlify bot commented Feb 3, 2025 •

edited

Loading