[DOCS-10339] The dataSize doc page does not mention the existence of "estimate" parameter Created: 02/Jun/17  Updated: 29/Oct/23  Resolved: 26/Oct/17

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

Type: Bug Priority: Major - P3
Reporter: Kevin Adistambha Assignee: Kevin Adistambha
Resolution: Fixed Votes: 0
Labels: collector-298ba4e7
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Location: https://docs.mongodb.com/manual/reference/command/dataSize/
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36
Referrer: https://docs.mongodb.com/v2.2/reference/command/dataSize/
Screen Resolution: 1440 x 900


Issue Links:
Documented
documents SERVER-1545 make single command for size and median Closed
Related
Participants:
Days since reply: 6 years, 15 weeks, 6 days ago

 Description   

The dataSize doc page mentions that the parameters into the command are the namespace, keypattern, min, and max. However, there is also an "estimate" boolean value parameter for the command that is not mentioned in the docs.

The dataSize command determines the total size of a range of documents, specified by its index key. The estimate parameter attempts to provide an estimated size instead, by walking the index and assuming the documents are uniformly sized (based on the average document size in the collection) instead of fetching the documents and calculating their actual size.

Relevant code for the estimate parameter in MongoDB 3.4: https://github.com/mongodb/mongo/blob/v3.4/src/mongo/db/commands/dbcommands.cpp#L859-L863

Relevant code for what the parameter does in MongoDB 3.4: https://github.com/mongodb/mongo/blob/v3.4/src/mongo/db/commands/dbcommands.cpp#L935-L936



 Comments   
Comment by Githook User [ 26/Oct/17 ]

Author:

{'email': 'kevinadi@gmail.com', 'name': 'Kevin Adistambha', 'username': 'kevinadi'}

Message: DOCS-10339 updated dataSize documentation page
Branch: master
https://github.com/mongodb/docs/commit/fc1e40deba6f731a864fe1b1f8c9e93b9b18e417

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