[DOCS-15997] [Server] Improve documentation of "planCacheSize" server parameter Created: 31/Mar/23  Updated: 13/Nov/23  Resolved: 06/Jun/23

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

Type: Improvement Priority: Critical - P2
Reporter: David Storch Assignee: Alison Huh
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to SERVER-75295 Disallow use of the 'planCacheSize' p... Closed
Participants:
Days since reply: 44 weeks, 2 days ago

 Description   

The documentation for the planCacheSize parameter could be improved in a few ways.

First, it may be worth clarifying that this parameter only affects the plan cache for the slot-based execution (SBE) engine. There is a separate plan cache for the classic execution engine which does not obey this parameter. As we ship more and more features in (SBE), we expect that the SBE plan cache will become the primary plan cache.

Second but perhaps more important, the docs state that this was new in version 5.1. That's stale and presumably the result of the fact that we originally planned to ship SBE and the SBE plan cache in an earlier version but ultimately chose to delay the release. We ended up shipping SBE for some limited $group/$lookup scenarios in 6.0 and did not release the SBE plan cache. In 6.2 we shipped some additional $lookup nested loop join plans in SBE. In 6.3, we did a much more broad release of SBE for find commands and also enabled the SBE plan cache. In 7.0, we plan to release a bit more so that I would expect most find commands to execute using SBE in 7.0.

The implications for the docs are that the SBE plan cache was first enabled in 6.3. Since the planCacheSize parameter is tied specifically to the SBE plan cache as explained above, this means that the planCacheSize parameter should be documented as new in 6.3 rather than new in 5.1.



 Comments   
Comment by David Storch [ 03/Apr/23 ]

Thanks sarah.olson@mongodb.com sounds good to me!

Comment by Sarah Olson [ 03/Apr/23 ]

Thanks david.storch@mongodb.com. I'm going to add this ticket to the work needed for 6.3. I'm also going to increase the priority a bit, based on wanting to clean up the inaccurate information. Please let me know if you disagree with this approach. 

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