Skip to content

docs: update SHOW PLAN NODE example to canonical protojson YAML#785

Merged
apstndb merged 1 commit into
mainfrom
docs/show-plan-node-canonical
Jul 8, 2026
Merged

docs: update SHOW PLAN NODE example to canonical protojson YAML#785
apstndb merged 1 commit into
mainfrom
docs/show-plan-node-canonical

Conversation

@apstndb

@apstndb apstndb commented Jul 8, 2026

Copy link
Copy Markdown
Owner

Summary

Follow-up to #784, which changed SHOW PLAN NODE output from the accidental reflection YAML dialect (snake_case proto field names like display_name/child_links, numeric enums like kind: 1) to canonical protojson-over-YAML (camelCase displayName/childLinks, named enums kind: RELATIONAL) with compact flow rendering for all-scalar sub-maps.

The SHOW PLAN NODE 18 example in docs/query_plan.md still depicted the old dialect. This updates it to match the new golden output in internal/mycli/statements_explain_describe_test.go (TestShowPlanNodeStatement_Execute).

Transformation applied

  • kind: 1 -> kind: RELATIONAL
  • display_name: -> displayName:
  • child_links: -> childLinks: (stays a block container)
  • child_index: -> childIndex: inside each childLinks flow item
  • execution_stats: -> executionStats: (stays a block container)

Keys inside metadata and each executionStats child (execution_method, cpu_time, scan_method, ...) are plan data and remain unchanged. The scanned_rows/histogram nesting 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 *.md found no other SHOW 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-update regenerates only README.md and docs/system_variables.md (not query_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

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

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

Code Metrics Report

📊 View detailed coverage report (available for 7 days)

main (750c4d2) #785 (17484d6) +/-
Coverage 73.1% 73.1% 0.0%
Code to Test Ratio 1:1.3 1:1.3 0.0
Test Execution Time 1m53s 1m39s -14s
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

@apstndb apstndb merged commit 7e15712 into main Jul 8, 2026
8 checks passed
@apstndb apstndb deleted the docs/show-plan-node-canonical branch July 8, 2026 05:09
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.

1 participant