-
Notifications
You must be signed in to change notification settings - Fork 465
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Explain each LIR operator #31054
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM -- mod a suggestion and a question or two?
@@ -22,11 +35,32 @@ operators: | |||
uses_memory: False | |||
memory_details: "" | |||
expansive: False | |||
expansive_details: | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! 😍
@@ -35,7 +69,8 @@ operators: | |||
uses_memory: False | |||
memory_details: "" | |||
expansive: False | |||
|
|||
expansive_details: | | |||
Each row has _less_ data (i.e., shorter rows, but same number of rows). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
@@ -241,6 +241,10 @@ Below the plan, a "Used indexes" section indicates which indexes will be used by | |||
### Reference: Plan operators | |||
|
|||
{{< tabs >}} | |||
{{< tab "In fully optimized LIR plans" >}} | |||
{{< explain-plans/operator-table data="explain_plan_operators" planType="lir" >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we talking about EXPLAIN PHYSICAL PLAN for VIEW/MATERIALIZED VIEW here, yes? If so, I think we should go with the PHYSICAL plans
.
example: "`Union 7 10 11 14 (consolidates output)`" | ||
|
||
- operator: ArrangeBy | ||
plan_types: "optimized" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be "lir"
?
@@ -218,6 +386,16 @@ operators: | |||
expansive: False | |||
example: "`ArrangeBy keys=[[#0]]`" | |||
|
|||
- operator: Arrange |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was this supposed to be ArrangeBy? (See comment on line https://github.com/MaterializeInc/materialize/pull/31054/files#diff-8a8cb8a7b9f7777ed5d1f88369aa9a4c9ef159e56cd49f4f1a2e309435d707deR370). -- although, the example has Arrange 12 ... but the description talks about keys.
There is new syntax for showing LIR terms in
mz_introspection.mz_lir_mapping
after #29848 and #30899; this adds documentation for it.Preview link
Motivation
Tips for reviewer
I snuck in a tiny fix to how
Get
andProject
were described---theexpansive_details
forGet
describedProject
.Checklist
$T ⇔ Proto$T
mapping (possibly in a backwards-incompatible way), then it is tagged with aT-proto
label.