[DOCS-11025] Docs for SERVER-31610: Consider adding a timestamp to plan cache entries Created: 15/Nov/17  Updated: 29/Oct/23  Resolved: 29/Nov/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 3.6.0-rc4

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Steve Renaker (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-31610 Consider adding a timestamp to plan c... Closed
Participants:
Days since reply: 6 years, 10 weeks, 6 days ago
Epic Link: DOCS: 3.6 Server
Story Points: 0.5

 Description   

Documentation Request Summary:

The output of the shell helper "PlanCache.getPlansByQuery()" now returns the same output as the command "planCacheListPlans". Rather than returning only the "plans" array, it returns the whole document stored in the plan cache for the specified query shape, of which the "plans" array is a field.

Engineering Ticket Description:

At present entries in the query plan cache do not have metadata about when they were generated. It would be helpful to have this to, for example, determine how recently the entry changed.



 Comments   
Comment by Githook User [ 30/Nov/17 ]

Author:

{'name': 'Steve Renaker', 'username': 'steveren', 'email': 'steve.renaker@mongodb.com'}

Message: DOCS-11025: added a timestamp to plan cache entries
Branch: master
https://github.com/mongodb/docs/commit/7bf7abf7316b1fc2e80c1147e26b40a3fd3ed4da

Comment by Steve Renaker (Inactive) [ 28/Nov/17 ]

I've added notes on the pages for database command "planCacheListPlans" and shell method PlanCache.getPlansByQuery() have the same output. We don't show sample output on those pages, probably because it's very long, so I didn't mention the new timestamp field, although I did add it to the 3.6 release notes. If anyone feels strongly that we should include sample output in the documentation, let me know and I'll add it.

Comment by Steve Renaker (Inactive) [ 20/Nov/17 ]

Ticket update: so far I haven't been able to create conditions in which the planCacheListPlans command returns anything at all. Still working on it, and I have questions out to a couple of developers.

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