Print included query info fields as yaml #526
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ptpaterson
force-pushed
the
fe-6247-query-info
branch
from
0819786 to
a7db158
Compare
jrodewig
approved these changes
Dec 13, 2024
ptpaterson
force-pushed
the
fe-6247-query-info
branch
from
c408636 to
28b4c13
Compare
ecooper
approved these changes
Dec 16, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ticket(s): FE-6247
Problem
As a user, we want to be able to view various query info fields when running queries.
Solution
This PR add a new common query option called
include, which can be an array of one or more of the following:If "all" is specified, all possible info fields should be displayed.
If
--performanceHintsis used, then at least the summary should be displayed. Don't worry if there are other components to the summary.The query info fields should displayed so that they can be read by people. Most importantly, the summary field should be displayed plainly, formatted the way it comes back from the db. That is, don't show a weird string full of escape characters.
I used the
yamlpackage to format the query info as an object and loaded the yaml colorizer. If color is on, we also apply FQL colorizing to appropriate summary lines.Result
query
shell
shell with toggling
Testing
All existing tests pass.
WIP: will add some more tests