docs: update SHOW PLAN NODE example to canonical protojson YAML#785
Merged
Conversation
PR #784 changed SHOW PLAN NODE output from the accidental reflection YAML dialect (snake_case proto field names, numeric enums) to canonical protojson-over-YAML (camelCase field names, named enums). The example in docs/query_plan.md still showed the old dialect. Apply the same transformation to the documented node-18 dump: - kind: 1 -> kind: RELATIONAL - display_name -> displayName, child_links -> childLinks, child_index -> childIndex, execution_stats -> executionStats Keys inside metadata/executionStats children (execution_method, cpu_time, scan_method, ...) are plan data and remain unchanged; the executionStats and childLinks block containers, scanned_rows/histogram nesting, and root block style are unchanged. The unchanged metadata line remains the widest content, so the CLI table frame stays 99 columns wide; only the shrunk lines were re-padded to keep the box aligned. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Du9UR1LPdSXk4wAZr4Nf4g
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the docs/query_plan.md file to use camelCase formatting for several keys (such as displayName, childLinks, childIndex, and executionStats) and changes the kind field value from 1 to RELATIONAL in the query plan node example. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Code Metrics Report📊 View detailed coverage report (available for 7 days)
Details | | main (750c4d2) | #785 (17484d6) | +/- |
|---------------------|----------------|----------------|------|
| Coverage | 73.1% | 73.1% | 0.0% |
| Files | 93 | 93 | 0 |
| Lines | 7917 | 7917 | 0 |
| Covered | 5794 | 5794 | 0 |
| Code to Test Ratio | 1:1.3 | 1:1.3 | 0.0 |
| Code | 18472 | 18472 | 0 |
| Test | 25146 | 25146 | 0 |
+ | Test Execution Time | 1m53s | 1m39s | -14s |Reported by octocov |
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
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
Follow-up to #784, which changed
SHOW PLAN NODEoutput from the accidental reflection YAML dialect (snake_case proto field names likedisplay_name/child_links, numeric enums likekind: 1) to canonical protojson-over-YAML (camelCasedisplayName/childLinks, named enumskind: RELATIONAL) with compact flow rendering for all-scalar sub-maps.The
SHOW PLAN NODE 18example indocs/query_plan.mdstill depicted the old dialect. This updates it to match the new golden output ininternal/mycli/statements_explain_describe_test.go(TestShowPlanNodeStatement_Execute).Transformation applied
kind: 1->kind: RELATIONALdisplay_name:->displayName:child_links:->childLinks:(stays a block container)child_index:->childIndex:inside each childLinks flow itemexecution_stats:->executionStats:(stays a block container)Keys inside
metadataand eachexecutionStatschild (execution_method,cpu_time,scan_method, ...) are plan data and remain unchanged. Thescanned_rows/histogramnesting and the document root stay block style.The unchanged
metadata: {...}line is the widest content, so the CLI table frame stays 99 columns wide; only the shrunk lines were re-padded to keep the box aligned.Scope
Repo-wide grep for stale dialect (
display_name:,child_links:,child_index:,kind: <n>,execution_stats:) across all*.mdfound no otherSHOW PLAN NODE-style YAML dumps. Other snake_case matches (e.g.(scan_method: Row)) are rendertree operator inline metadata, a different rendering, and were intentionally left untouched.Validation
Docs-only change.
make docs-updateregenerates onlyREADME.mdanddocs/system_variables.md(notquery_plan.md), and there is no markdownlint gate, so CI docs checks are unaffected.go build ./...passes.🤖 Generated with Claude Code
https://claude.ai/code/session_01Du9UR1LPdSXk4wAZr4Nf4g