feat: add formatJsonExplain, rename library-only fields - #32
Merged
Conversation
pulpdrew
changed the title
pulpdrew
force-pushed
the
drew/formatJsonExplain
branch
from
July 9, 2026 11:37
6b3ee6c to
22b0702
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR introduces a new formatter - formatJsonExplain(ast, version), which formats the library's AST as a reference AST wrapped in a
{ version, ast }object, matching the ClickHouse reference EXPLAIN AST json=1 output.All library-only fields are stripped by the formatter. Such fields have been renamed to omit the
_prefix which previously marked them as library-only. Now we are forced to specifically enumerate each library-only field (something which is useful due to agents writing the majority of this library's code). These fields also now follow the naming conventions of other fields in the AST.Finally, I've eliminated the "volatile" auth fields - these now survive round-trip through the formatter. Their omission was an oversight previously.