Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-12873

Investigate changes in SERVER-36800: Deprecate 'planCacheListPlans' and 'planCacheListQueryShapes' commands

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Fixed
    • Icon: Major - P3 Major - P3
    • 4.3.1, 4.2.0-rc3
    • None
    • None
    • None

    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.)

      Attachments

        Activity

          People

            kay.kim@mongodb.com Kay Kim (Inactive)
            backlog-server-pm Backlog - Core Eng Program Management Team
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              4 years, 30 weeks, 6 days ago