Make tree the Default EXPLAIN Format and Reorder Documentation Sections #15706
Conversation
This file contains hidden or 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
github-actions
bot
added
the
documentation
kosiew
force-pushed
the
explain-doc-default-format
branch
from
eabaa9f to
596f131
Compare
nirnayroy
pushed a commit
to nirnayroy/datafusion
that referenced
this pull request
May 2, 2025
Member
|
follow-up - #16085 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Which issue does this PR close?
Rationale for this change
#15427 changed the default EXPLAIN format to
tree.This PR updates the EXPLAIN documentation to reflect that the
treeformat is now the default, instead ofindent. This reordering ensures that users see the format that matches actual output first, improving clarity and user experience when reading or debugging EXPLAIN plans.What changes are included in this PR?
treeis the default format.treeformat section above theindentformat section for logical flow.Are these changes tested?
Not applicable. These are documentation-only changes and do not impact functionality.
Are there any user-facing changes?
Yes. The documentation now:
treeformat as the default EXPLAIN output.treeformat example first for easier reference.