Skip to content

chore: Document Comet runtime data debug #4235

Open
comphead wants to merge 5 commits intoapache:mainfrom
comphead:dbg
Open

chore: Document Comet runtime data debug #4235
comphead wants to merge 5 commits intoapache:mainfrom
comphead:dbg

Conversation

@comphead
Copy link
Copy Markdown
Contributor

@comphead comphead commented May 6, 2026

Which issue does this PR close?

Closes #.

Rationale for this change

Document one of the ways how to debug a running query data for specific operator

What changes are included in this PR?

How are these changes tested?

comphead and others added 5 commits May 5, 2026 17:06
Introduce a small ExecutionPlan wrapper, DbgExec, that applies the
existing dbg_batch_stream helper to whatever its inner plan emits.
This lets contributors drop a one-line wrap around any native operator
to see the RecordBatches it actually produces (values, schema, and
per-column null buffers), which is hard to infer from a failing
DataFrame assertion alone. Document it in the contributor debugging
guide with a worked LEAD IGNORE NULLS example.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
need whichever one matches the granularity you want to trace — they are
independent.

```rust
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this code should be part of the product so we make sure it always compiiles in CI. Can we put this functionality behind a config somehow?

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.

2 participants