Azure-docs: The legend in the diagram, next to read, insert, upsert is vague
The legend in the diagram, used above, next to read, insert, upsert, etc. is vague. Some readers thought they are representing RUs. It would be helpful to elaborate what these boxes are representing (is it RU or is it Replica etc.). Also, some information on read (point read), vs query (select query) in the context would be helpful for the readers.
Document Details
⚠Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
- ID: abb0beaa-01ab-7031-937e-2d44c147b5d2
- Version Independent ID: 742b249e-054f-a160-c2f5-7c22a796f9d0
- Content: Request Units and throughput in Azure Cosmos DB
- Content Source: articles/cosmos-db/request-units.md
- Service: cosmos-db
- GitHub Login: @rimman
- Microsoft Alias: rimman
msdpalam
All 11 comments
@msdpalam Thanks for your feedback! We will investigate and update as appropriate.
CHEEKATLAPRADEEP-MSFT
on 8 Mar 2019
@msdpalam Thanks for your valuable feedback. I have assigned this issue to the content author to update the document appropriately. So that there is no confusion going forward.
@rimman Could you please look at this issue and update the document appropriately.
angoyal-msft
on 8 Mar 2019
This is not a legend. This is showing that database operations (CRUD and query) consume RUs. The visual is not intended to be taken literally - it shows visually a logical concept of RUs.
This GitHub issue can be closed. Thank you!
rimman
on 8 Mar 2019
Unfortunately, the diagram does not successfully communicate that database operations consume RUs, nor does it show visually a logical concept of RUs. Instead, it communicates (falsely) that, for example, inserts and upsets take exactly 3x the RUs as a read. The GitHub issue should not be closed.
olofh-msft
on 8 Mar 2019
This is an eye-candy, should not be taken literally. We can put a figure capture explicitly saying: this is a conceptual drawing that should not be interpreted literally. Thanks.
rimman
on 8 Mar 2019
How about putting a figure caption saying "This figure has been removed because it was ugly and confusing"?
olofh-msft
on 8 Mar 2019
If the operations are not proportional to the units, it might be helpful to remove the equations altogether and just leave the five operation names
PatMyron
on 10 Mar 2019
@olofh-msft, @PatMyron thanks for your detailed feedback, we tried to clarify the confusing aspects you have pointed by updating the image, my PR above updates the image in the doc.
Read request consumes 1RU, and for other operations its variable and based in the doc size, query operations usually consume more RUs. we have removed the fixed number of blocks and made them variable, the width for query operations is higher compared to the other operations to convey the above message. Hope this helps!
We will close the issue if you don't have any further questions. Thanks!
SnehaGunda
on 27 Mar 2019
My opinion is that the documentation would be clearer without any image at all. Even with the revisions, the image adds no useful information, and has the potential to communicate incorrect information.
If it is desired to have information about the different RU costs of the different operations, there should be a table with exact values of the RU costs of different operations.
- Olof
From: Sneha Gunda notifications@github.com
Reply-To: MicrosoftDocs/azure-docs reply@reply.github.com
Date: Tuesday, March 26, 2019 at 4:45 PM
To: MicrosoftDocs/azure-docs azure-docs@noreply.github.com
Cc: Olof Hellman Olof.Hellman@microsoft.com, Mention mention@noreply.github.com
Subject: Re: [MicrosoftDocs/azure-docs] The legend in the diagram, next to read, insert, upsert is vague (#26502)
@olofh-msfthttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Folofh-msft&data=02%7C01%7COlof.Hellman%40microsoft.com%7Cabf6458f196e47b3122f08d6b24528dd%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636892407438683926&sdata=1lea7YyMHZWRlAyaSAA8MZkvO9Wf2yDOiM3Q4SvBkss%3D&reserved=0, @PatMyronhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FPatMyron&data=02%7C01%7COlof.Hellman%40microsoft.com%7Cabf6458f196e47b3122f08d6b24528dd%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636892407438683926&sdata=PMXfHa2HmVepZt1DorTXqwMaqW9yIvQu4zRgPnokxFo%3D&reserved=0 thanks for your detailed feedback, we tried to clarify the confusing aspects you have pointed by updating the image, my PR above updates the image in the doc.
Read request consumes 1RU, and for other operations its variable and based in the doc size, query operations usually consume more RUs. we have removed the fixed number of blocks and made them variable, the width for query operations is higher compared to the other operations to convey the above message. Hope this helps!
We will close the issue if you don't have any further questions. Thanks!
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FMicrosoftDocs%2Fazure-docs%2Fissues%2F26502%23issuecomment-476898398&data=02%7C01%7COlof.Hellman%40microsoft.com%7Cabf6458f196e47b3122f08d6b24528dd%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636892407438703942&sdata=8cURDGFCse4hOQGrevKJtTrA4F8XvKTh0wNqQzFMGeg%3D&reserved=0, or mute the threadhttps://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAk8ZrFvpIdre3DLyf5trXyTXci0EKk1Kks5varElgaJpZM4bkUh7&data=02%7C01%7COlof.Hellman%40microsoft.com%7Cabf6458f196e47b3122f08d6b24528dd%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636892407438703942&sdata=QGSLnKg7DqDDmatlFYME6RL9PrQk50Ntk9ydQPTGBP4%3D&reserved=0.
olofh-msft
on 27 Mar 2019
@olofh-msft RU charge isn't fixed for different operations, its variable and dependent on the document size. I think the image captures the message.
SnehaGunda
on 27 Mar 2019
please-close
SnehaGunda
on 28 Mar 2019
Related issues
jharbieh
·
3Comments
Agazoth
·
3Comments
spottedmahn
·
3Comments
varma31
·
3Comments
mrdfuse
·
3Comments