[DOCS-16424] [SERVER] Describe what to expect from change streams update description Created: 06/Oct/23  Updated: 22/Jan/24

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

Type: Task Priority: Major - P3
Reporter: Katya Kamenieva Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: backlog, change-streams, feature
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-71269 Use compact diff format for updates t... Backlog
related to SERVER-72941 Use compact diff format for updates t... Closed
Participants:
Days since reply: 17 weeks, 2 days ago

 Description   

We see questions about the output of the change streams.
When user issues update command it may result in change type:

  • 'update'
  • 'replace', if writing down the diff is more verbose than the final version of the document
  • 'insert', if upset:true was set and no matching documents wre found to update

For update there's sub-case for how updates to arrays are represented. Here is example of the question/complaint SERVER-75590. Similarly to the whole-document update vs insert, we may output truncation of array, update to the individual array element or rewrite entire array. We are biased toward for concise representation of the updates where possible (although some legacy update operators might still produce more lengthy versions)

I'm not sure what is the best place for it in docs, but I'd like us to add some info around it. The intent is not to document the minutia of the current logic (we want to keep room for potential changes), but to highlight that when building change processors, users should be ready to receive descriptions of the updates in the various formats as it's hard to predict how exactly each operation will be represented in the change event.



 Comments   
Comment by Sarah Olson [ 09/Oct/23 ]

Thanks kateryna.kamenieva@mongodb.com, we'll look into this as part of our backlog work!

Generated at Thu Feb 08 08:15:21 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.