DOCSP 29155 adding sort and uuids to mongosync page #230

ltran-mdb2 · 2023-12-18T20:37:14Z

DESCRIPTION

adding sorting and uuids information to mongosync page

STAGING

https://preview-mongodbltranmdb2.gatsbyjs.io/cluster-sync/DOCSP-29155/reference/mongosync/#uuids

JIRA

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

BUILD LOG

https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=6580ab867a5cb5fef55f4e19

Self-Review Checklist

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?

MongoCaleb

A few suggestions.

MongoCaleb · 2023-12-19T23:19:30Z

source/reference/mongosync.txt

+Sorting
+~~~~~~~
+
+``mongosync`` creates a new natural (without any sort method specified)


I think it reads better to say "creates a new natural order (without any sort method specified) on the ..."

MongoCaleb · 2023-12-19T23:23:35Z

source/reference/mongosync.txt

+``mongosync`` creates a new natural (without any sort method specified)
+order on the destination cluster. If applications depend on document
+order without a defined sort method, they may require additional updating to
+work with a migrated cluster. 


I think this can be cleaned up a bit and also be more specific about what needs to be updated. Perhaps:

If applications depend on document order, but don't have a defined sort method, they may need to be updated to specify the expected sort order before they will work properly with the migrated cluster.

MongoCaleb · 2023-12-19T23:24:45Z

source/reference/mongosync.txt

+UUIDs
+~~~~~
+
+``mongosync`` creates new universally unique identifiers (UUIDs) for


I don't know if we should use this:
:abbr:`UUIDs (universally unique identifiers)`

Done! (I was not aware of this markup so thank you so much for pointing it out!)

MongoCaleb · 2023-12-19T23:26:35Z

source/reference/mongosync.txt

+``mongosync`` creates new universally unique identifiers (UUIDs) for
+collections on the destination cluster. There is no relationship between
+UUIDs on the source cluster and the destination cluster. If applications
+contain hard-coded collection UUIDs (which MongoDB does not recommend),


Are they "collection UUIDs" or document UUIDs within a collection? If the latter, I suggest just dropping the word "collection".

ltran-mdb2 · 2023-12-20T15:14:20Z

Thanks for your feedback @MongoCaleb ! Could you take another look when you get a chance?

MongoCaleb

I'm LGTMing, but there's one important question to check on.

MongoCaleb · 2023-12-20T17:51:24Z

source/reference/mongosync.txt

+between UUIDs on the source cluster and the destination cluster. If
+applications contain hard-coded UUIDs (which MongoDB does not
+recommend), you may need to update the application's UUIDs before the
+application works properly with a migrated cluster. 


One last comment. Can you actually change the UUIDs? I would be surprised if this were the case.

Checked in with Alex Komyagin who said the "The developer would need to get the new UUID's from the new cluster or update the app not to rely on UUIDs" so I changed the phrasing accordingly

FGasper

The gist of what’s here is accurate. I’ve left a couple technical-nit comments, and one grammatical nit. See what you think.

Thank you!

FGasper · 2024-01-05T16:01:15Z

source/reference/mongosync.txt

+``mongosync`` creates new :abbr:`UUIDs (universally unique identifiers)`
+for collections on the destination cluster. There is no relationship


mongosync doesn’t “create UUIDs” per se; rather, it creates collections, which have UUIDs.

Suggested change

``mongosync`` creates new :abbr:`UUIDs (universally unique identifiers)`

for collections on the destination cluster. There is no relationship

The collections that ``mongosync`` creates on the destination cluster

have new :abbr:`UUIDs (universally unique identifiers)`. There is no relationship

FGasper · 2024-01-05T16:02:25Z

source/reference/mongosync.txt

+update the application to specify the expected sort order before the
+application works properly with the migrated cluster. 


Just a grammatical nit:

Suggested change

update the application to specify the expected sort order before the

application works properly with the migrated cluster.

update those applications to specify the expected sort order before the

applications work properly with the migrated cluster.

FGasper · 2024-01-05T16:05:39Z

source/reference/mongosync.txt

+``mongosync`` creates a new natural order (without any sort method
+specified) on the destination cluster. If applications depend on


mongosync doesn’t “create an order”; rather, the order in which it inserts documents is undefined.

Suggested change

``mongosync`` creates a new natural order (without any sort method

specified) on the destination cluster. If applications depend on

``mongosync`` inserts documents on the destination cluster in an undefined order.

Thus, natural sort order is not preserved from the source to the destination. If applications

depend on

ltran-mdb2 · 2024-01-05T17:36:50Z

Thanks for your feedback @FGasper ! Could you take another look at this when you get a chance?

FGasper

LGTM. Thanks!

* DOCSP-29155 adding behavior info to mongosync * DOCSP-29155 adding sorting and uuids to mongosync page * DOCSP-29155 adding sorting and uuids to mongosync page * DOCSP-29155 copy edits * DOCSP-29155 copy edit * DOCSP-29155 tech edits * DOCSP-29155 tech edits * DOCSP-29155 tech edits * DOCSP-29155 tech edits * DOCSP-29155 tech edit

ltran-mdb2 added 3 commits December 18, 2023 15:21

DOCSP-29155 adding behavior info to mongosync

0d1bc99

DOCSP-29155 adding sorting and uuids to mongosync page

f92db35

DOCSP-29155 adding sorting and uuids to mongosync page

12c927f

MongoCaleb reviewed Dec 19, 2023

View reviewed changes

DOCSP-29155 copy edits

5490dd9

MongoCaleb approved these changes Dec 20, 2023

View reviewed changes

DOCSP-29155 copy edit

b4b8ab8

FGasper suggested changes Jan 5, 2024

View reviewed changes

ltran-mdb2 added 4 commits January 5, 2024 12:02

DOCSP-29155 tech edits

9de5f6c

DOCSP-29155 tech edits

f2ed4e0

DOCSP-29155 tech edits

c3a786f

DOCSP-29155 tech edits

b25f74c

FGasper approved these changes Jan 9, 2024

View reviewed changes

DOCSP-29155 tech edit

8ffcd92

sarah-olson-mongodb merged commit 4027ad4 into mongodb:master Jan 9, 2024

ltran-mdb2 mentioned this pull request Jan 11, 2024

DOCSP 29155 adding sort and uuids to mongosync page (#230) #236

Merged

		``mongosync`` creates new :abbr:`UUIDs (universally unique identifiers)`
		for collections on the destination cluster. There is no relationship

		update the application to specify the expected sort order before the
		application works properly with the migrated cluster.

		``mongosync`` creates a new natural order (without any sort method
		specified) on the destination cluster. If applications depend on

DOCSP 29155 adding sort and uuids to mongosync page #230

DOCSP 29155 adding sort and uuids to mongosync page #230

Uh oh!

Conversation

ltran-mdb2 commented Dec 18, 2023

DESCRIPTION

STAGING

JIRA

BUILD LOG

Self-Review Checklist

External Review Requirements

Uh oh!

MongoCaleb 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!

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!

ltran-mdb2 commented Dec 20, 2023

Uh oh!

MongoCaleb 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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ltran-mdb2 commented Jan 5, 2024

Uh oh!

FGasper left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants