[DOCS-12873] Investigate changes in SERVER-36800: Deprecate 'planCacheListPlans' and 'planCacheListQueryShapes' commands Created: 10/Jul/19  Updated: 29/Oct/23  Resolved: 11/Jul/19

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 4.3.1, 4.2.0-rc3

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Kay Kim (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-36800 Deprecate 'planCacheListPlans' and 'p... Closed
Duplicate
Participants:
Days since reply: 4 years, 30 weeks, 6 days ago
Epic Link: DOCS: 4.2 Server/Tools

 Description   

Description

SERVER ticket description:

These older commands are superseded by the new $planCacheStats aggregation metadata source implemented for 4.2 in SERVER-36528. They are inferior in that:

  1. They do not return a cursor.
  2. They do not permit projection, grouping, filtering, or other transformations using the full expressivity of the aggregation language.
  3. The 'planCacheListPlans' command displays its output in a less useful format than $planCacheStats.

Change Description:

This change adds code comments and log lines which warn that the planCacheListPlans and planCacheListQueryShapes commands are deprecated. This changed has been merged in 4.3.1 and is slated for backport to a 4.2 RC. We intend to completely remove support for these commands in a future 4.3.x version, but that work has not been scheduled yet.

The reference pages for these commands should be updated to note deprecation in 4.2 once the change has been backported. We should also add a deprecation notice to the 4.2 compatibility notes. Any users who rely on these commands should migrate to the $planCacheStats agg stage, which has already been documented.

I don't think any drivers provide helpers for these commands, but if they do, those helpers should be deprecated.

Cloud has already indicated that they are not affected in CLOUDP-44434.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 11/Jul/19 ]

Author:

{'name': 'Kay Kim', 'username': 'kay-kim', 'email': 'kay.kim@10gen.com'}

Message: DOCS-12873: 4.2 deprecate planCacheListPlans and planCacheListQueryShapes
Branch: master
https://github.com/mongodb/docs/commit/7cd5e568b8bde63dd27dcf52a8f5f26489cc6d65

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