Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-54083

Include scores calculated by PlanRanker in explain "queryPlanner" output and/or "allPlansExecution"

    • Type: Icon: Improvement Improvement
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 5.1.0-rc0
    • Affects Version/s: None
    • Component/s: Querying
    • Labels:
    • Fully Compatible
    • Query Optimization 2021-07-12, Query Optimization 2021-07-26, Query Optimization 2021-08-09, QO 2021-08-23

      One important use case for explain is determining why the system chose one candidate plan as the winner and rejected others. This information can currently derived from "allPlansExecution" output, but this requires some internal knowledge of how the PlanRanker's score calculation is implemented. Our internal Query Doctor tool, for example, calculates these scores itself (christopher.harris please correct me if this wrong). There is a risk that Query Doctor could end up diverging from the server's behavior with regards to plan score calculation, thereby misinterpreting the explain output.

      We should consider simplifying the situation by simply exposing the plan scores. These could be exposed alongside the "winningPlan" and each "rejectedPlan", as well as alongside each plan in the "allPlansExecution" section. Although these scores are very much subject to change (or even go away entirely) as the internals of the query optimization subsystem change, I don't see a harm in exposing them. This is especially true given that explain's output format is excluded from the stable API, and is subject to change as the implementation details of the query system change.

            Assignee:
            alice.doherty@mongodb.com Alice Doherty
            Reporter:
            david.storch@mongodb.com David Storch
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Created:
              Updated:
              Resolved: