Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mango query explain page #1415

Merged
merged 26 commits into from
Nov 17, 2023

Conversation

mharrigan26
Copy link
Contributor

@mharrigan26 mharrigan26 commented Oct 17, 2023

Overview

This PR adds a parsed view of the Explain Page to accompany the addition of index_candidates to the /_explain endpoint in Couch 3.4. The current page is very bare bones and provides no guidance to users in terms of why a index was selected or not. The parsed page would indicate the selected index along with other possible candidates and why they were not selected. This is to help the user better understand and make more efficient queries.

Testing recommendations

Run a mango query on a database. Select Explain and check that there is now a parsed output and raw json output explaining the query.

GitHub issue number

Related Pull Requests

Checklist

  • Code is written and works correctly;
  • Changes are covered by tests;
  • Documentation reflects the changes;
  • Update rebar.config.script with the correct tag once a new Fauxton release is made

@mharrigan26 mharrigan26 marked this pull request as draft October 17, 2023 18:28
@mharrigan26 mharrigan26 marked this pull request as ready for review November 16, 2023 18:05
Copy link
Contributor

@Antonio-Maranhao Antonio-Maranhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 provided all checks pass

@Antonio-Maranhao Antonio-Maranhao merged commit 1b2c7e4 into apache:main Nov 17, 2023
3 checks passed
@mharrigan26 mharrigan26 deleted the mango-query-explain-page branch November 29, 2023 21:23
@mharrigan26 mharrigan26 restored the mango-query-explain-page branch December 14, 2023 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants