[DOCS-15728] [Server] Add warning to sh.moveChunk that this method should not be used with a hashed shard key Created: 09/Nov/22  Updated: 30/Oct/23  Resolved: 20/Jan/23

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Task Priority: Minor - P4
Reporter: Allison Easton Assignee: Lindsey Moore
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 1 year, 2 weeks, 6 days ago
Epic Link: DOCSP-11701

 Description   

The move chunk command can be used either with a query option or a bounds option. The query option should be used for regular shard keys while bounds should be used for hashed shard keys. This is already documented correctly in the moveChunk page of the docs.

The sh.moveChunk helper only allows the use of the query option. This isn't really documented well, and so users that go to this page rather than the moveChunk page often don't realize that sh.moveChunk should not be used with hashed shard keys.

I propose adding a warning to the description of the command. The first paragraph can be changed by adding to the end something similar to: "This command uses the find option from the moveChunk command, and should not be used for hashed shard keys. To move a chunk with a hashed shard key, use the moveChunk command specifying the bounds field."



 Comments   
Comment by Githook User [ 19/Jan/23 ]

Author:

{'name': 'lindseymoore', 'email': '71525840+lindseymoore@users.noreply.github.com', 'username': 'lindseymoore'}

Message: DOCS-15728 sh.moveChunk can't be used with hashed shard key (#2386)

  • DOCS-15728 sh.moveChunk can't be used with hashed shard key
Generated at Thu Feb 08 08:13:42 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.