Skip to content

opt: add PlanGramMismatchPenalty cost penalty flag #169717

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.

Sign up for GitHub

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

Merged
trunk-io merged 1 commit into from
May 7, 2026
+23 −4
Merged

opt: add PlanGramMismatchPenalty cost penalty flag #169717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions pkg/sql/opt/memo/cost.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ type Cost struct {
// member will have a lower cost.
var MaxCost = Cost{
C: math.Inf(+1),
Penalties: HugeCostPenalty | FullScanPenalty | UnboundedCardinalityPenalty,
Penalties: HugeCostPenalty | FullScanPenalty | PlanGramMismatchPenalty | UnboundedCardinalityPenalty,
}

// Less returns true if this cost is lower than the given cost.
Expand Down Expand Up @@ -105,6 +105,11 @@ const (
// plan is possible.
FullScanPenalty

// PlanGramMismatchPenalty is true if the plan does not match the required
// PlanGram pattern, indicating that this plan should only be used if no
// PlanGram-matching plan is possible.
PlanGramMismatchPenalty

// UnboundedCardinalityPenalty is true if the operator or any of its
// descendants have no guaranteed upperbound on the number of rows that they
// can produce. See props.AnyCardinality.
Expand All @@ -121,8 +126,9 @@ const (
// Where:
//
// <Cost> is the floating point cost value.
// <Penalties> contains "H", "F", or "U" for HugeCostPenalty, FullScanPenalty,
// and UnboundedCardinalityPenalty, respectively.
// <Penalties> contains "H", "F", "P", or "U" for HugeCostPenalty,
// FullScanPenalty, PlanGramMismatchPenalty, and
// UnboundedCardinalityPenalty, respectively.
// <aux> contains the number of full scans and unbounded reads.
//
// For example, the summary "1.23:HF:5f6u" indicates a cost of 1.23 with the
Expand All @@ -137,6 +143,9 @@ func (c Cost) Summary() string {
if c.Penalties&FullScanPenalty != 0 {
sb.WriteByte('F')
}
if c.Penalties&PlanGramMismatchPenalty != 0 {
sb.WriteByte('P')
}
if c.Penalties&UnboundedCardinalityPenalty != 0 {
sb.WriteByte('U')
}
Expand Down
9 changes: 8 additions & 1 deletion pkg/sql/opt/memo/cost_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,12 @@ func TestCostLess(t *testing.T) {
{MaxCost, MaxCost, false},
{MaxCost, Cost{C: 1.0, Penalties: FullScanPenalty}, false},
{Cost{C: 1.0, Penalties: HugeCostPenalty}, MaxCost, true},
{Cost{C: 2.0}, Cost{C: 1.0, Penalties: PlanGramMismatchPenalty}, true},
{Cost{C: 1.0, Penalties: PlanGramMismatchPenalty}, Cost{C: 2.0}, false},
{Cost{C: 2.0}, Cost{C: 1.0, Penalties: UnboundedCardinalityPenalty}, true},
{Cost{C: 1.0, Penalties: UnboundedCardinalityPenalty}, Cost{C: 2.0}, false},
{Cost{C: 1.0, Penalties: UnboundedCardinalityPenalty}, Cost{C: 1.0, Penalties: PlanGramMismatchPenalty}, true},
{Cost{C: 1.0, Penalties: PlanGramMismatchPenalty}, Cost{C: 1.0, Penalties: FullScanPenalty}, true},
// Auxiliary information should not affect the comparison.
{Cost{C: 1.0, aux: testAux{0, 0}}, Cost{C: 1.0, aux: testAux{1, 1}}, false},
{Cost{C: 1.0, aux: testAux{1, 1}}, Cost{C: 1.0, aux: testAux{0, 0}}, false},
Expand All @@ -59,6 +63,8 @@ func TestCostAdd(t *testing.T) {
{Cost{C: 1.5}, Cost{C: 2.5}, Cost{C: 4.0}},
{Cost{C: 1.0, Penalties: FullScanPenalty}, Cost{C: 2.0}, Cost{C: 3.0, Penalties: FullScanPenalty}},
{Cost{C: 1.0}, Cost{C: 2.0, Penalties: HugeCostPenalty}, Cost{C: 3.0, Penalties: HugeCostPenalty}},
{Cost{C: 1.0, Penalties: PlanGramMismatchPenalty}, Cost{C: 2.0, Penalties: FullScanPenalty}, Cost{C: 3.0, Penalties: FullScanPenalty | PlanGramMismatchPenalty}},
{Cost{C: 1.0, Penalties: PlanGramMismatchPenalty}, Cost{C: 2.0, Penalties: PlanGramMismatchPenalty}, Cost{C: 3.0, Penalties: PlanGramMismatchPenalty}},
{Cost{C: 1.0, Penalties: UnboundedCardinalityPenalty}, Cost{C: 2.0, Penalties: HugeCostPenalty}, Cost{C: 3.0, Penalties: HugeCostPenalty | UnboundedCardinalityPenalty}},
{Cost{C: 1.0, aux: testAux{1, 4}}, Cost{C: 1.0, aux: testAux{2, 5}}, Cost{C: 2.0, aux: testAux{3, 9}}},
{Cost{C: 1.0, aux: testAux{65530, 65530}}, Cost{C: 1.0, aux: testAux{100, 100}}, Cost{C: 2.0, aux: testAux{65535, 65535}}},
Expand All @@ -81,8 +87,9 @@ func TestCostSummary(t *testing.T) {
{Cost{C: 1.23456}, "1.23456::0f0u"},
{Cost{C: 1.23, Penalties: HugeCostPenalty}, "1.23:H:0f0u"},
{Cost{C: 1.23, Penalties: FullScanPenalty}, "1.23:F:0f0u"},
{Cost{C: 1.23, Penalties: PlanGramMismatchPenalty}, "1.23:P:0f0u"},
{Cost{C: 1.23, Penalties: UnboundedCardinalityPenalty}, "1.23:U:0f0u"},
{Cost{C: 1.23, Penalties: HugeCostPenalty | FullScanPenalty | UnboundedCardinalityPenalty}, "1.23:HFU:0f0u"},
{Cost{C: 1.23, Penalties: HugeCostPenalty | FullScanPenalty | PlanGramMismatchPenalty | UnboundedCardinalityPenalty}, "1.23:HFPU:0f0u"},
{Cost{C: 1.23, Penalties: HugeCostPenalty | FullScanPenalty | UnboundedCardinalityPenalty}, "1.23:HFU:0f0u"},
{Cost{C: 1.23, aux: testAux{5, 0}}, "1.23::5f0u"},
{Cost{C: 1.23, aux: testAux{0, 6}}, "1.23::0f6u"},
Expand Down
3 changes: 3 additions & 0 deletions pkg/sql/opt/memo/expr_format.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -933,6 +933,9 @@ func (f *ExprFmtCtx) formatRelational(e RelExpr, tp treeprinter.Node) {
if cost.Penalties&HugeCostPenalty != 0 {
b.WriteString(" huge-cost-penalty")
}
if cost.Penalties&PlanGramMismatchPenalty != 0 {
b.WriteString(" plangram-mismatch")
}
if cost.Penalties&UnboundedCardinalityPenalty != 0 {
b.WriteString(" unbounded-cardinality")
}
Expand Down
Loading