risingwave_frontend/optimizer/rule/
mod.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! Define all [`Rule`]
16
17use std::convert::Infallible;
18use std::ops::FromResidual;
19
20use thiserror_ext::AsReport;
21
22use super::PlanRef;
23use crate::error::RwError;
24
25/// Result when applying a [`Rule`] to a [`PlanNode`](super::plan_node::PlanNode).
26pub enum ApplyResult<T = PlanRef> {
27    /// Successfully applied the rule and returned a new plan.
28    Ok(T),
29    /// The current rule is not applicable to the input.
30    /// The optimizer may try another rule.
31    NotApplicable,
32    /// An unrecoverable error occurred while applying the rule.
33    /// The optimizer should stop applying other rules and report the error to the user.
34    Err(RwError),
35}
36
37impl ApplyResult {
38    /// Unwrap the result, panicking if it's not `Ok`.
39    pub fn unwrap(self) -> PlanRef {
40        match self {
41            ApplyResult::Ok(plan) => plan,
42            ApplyResult::NotApplicable => panic!("unwrap ApplyResult::NotApplicable"),
43            ApplyResult::Err(e) => panic!("unwrap ApplyResult::Err, error: {:?}", e.as_report()),
44        }
45    }
46}
47
48/// Allow calling `?` on an `Option` in a function returning `ApplyResult`.
49impl<T> FromResidual<Option<Infallible>> for ApplyResult<T> {
50    fn from_residual(residual: Option<Infallible>) -> Self {
51        match residual {
52            Some(i) => match i {},
53            None => Self::NotApplicable,
54        }
55    }
56}
57
58/// Allow calling `?` on a `Result` in a function returning `ApplyResult`.
59impl<T, E> FromResidual<Result<Infallible, E>> for ApplyResult<T>
60where
61    E: Into<RwError>,
62{
63    fn from_residual(residual: Result<Infallible, E>) -> Self {
64        match residual {
65            Ok(i) => match i {},
66            Err(e) => Self::Err(e.into()),
67        }
68    }
69}
70
71/// An one-to-one transform for the [`PlanNode`](super::plan_node::PlanNode).
72///
73/// It's a convenient trait to implement [`FallibleRule`], thus made available only within this module.
74trait InfallibleRule: Send + Sync + Description {
75    /// Apply the rule to the plan node.
76    ///
77    /// - Returns `Some` if the apply is successful.
78    /// - Returns `None` if it's not applicable. The optimizer may try other rules.
79    fn apply(&self, plan: PlanRef) -> Option<PlanRef>;
80}
81use InfallibleRule as Rule;
82
83/// An one-to-one transform for the [`PlanNode`](super::plan_node::PlanNode) that may return an
84/// unrecoverable error that stops further optimization.
85///
86/// An [`InfallibleRule`] is always a [`FallibleRule`].
87pub trait FallibleRule: Send + Sync + Description {
88    /// Apply the rule to the plan node, which may return an unrecoverable error.
89    ///
90    /// - Returns `ApplyResult::Ok` if the apply is successful.
91    /// - Returns `ApplyResult::NotApplicable` if it's not applicable. The optimizer may try other rules.
92    /// - Returns `ApplyResult::Err` if an unrecoverable error occurred. The optimizer should stop applying
93    ///   other rules and report the error to the user.
94    fn apply(&self, plan: PlanRef) -> ApplyResult;
95}
96
97impl<T> FallibleRule for T
98where
99    T: InfallibleRule,
100{
101    fn apply(&self, plan: PlanRef) -> ApplyResult {
102        match InfallibleRule::apply(self, plan) {
103            Some(plan) => ApplyResult::Ok(plan),
104            None => ApplyResult::NotApplicable,
105        }
106    }
107}
108
109pub trait Description {
110    fn description(&self) -> &str;
111}
112
113pub(super) type BoxedRule = Box<dyn FallibleRule>;
114
115mod logical_filter_expression_simplify_rule;
116pub use logical_filter_expression_simplify_rule::*;
117mod over_window_merge_rule;
118pub use over_window_merge_rule::*;
119mod project_join_merge_rule;
120pub use project_join_merge_rule::*;
121mod project_eliminate_rule;
122pub use project_eliminate_rule::*;
123mod project_merge_rule;
124pub use project_merge_rule::*;
125mod pull_up_correlated_predicate_rule;
126pub use pull_up_correlated_predicate_rule::*;
127mod index_delta_join_rule;
128pub use index_delta_join_rule::*;
129mod left_deep_tree_join_ordering_rule;
130pub use left_deep_tree_join_ordering_rule::*;
131mod apply_agg_transpose_rule;
132pub use apply_agg_transpose_rule::*;
133mod apply_filter_transpose_rule;
134pub use apply_filter_transpose_rule::*;
135mod apply_project_transpose_rule;
136pub use apply_project_transpose_rule::*;
137mod apply_eliminate_rule;
138pub use apply_eliminate_rule::*;
139mod translate_apply_rule;
140pub use translate_apply_rule::*;
141mod merge_multijoin_rule;
142pub use merge_multijoin_rule::*;
143mod max_one_row_eliminate_rule;
144pub use max_one_row_eliminate_rule::*;
145mod apply_join_transpose_rule;
146pub use apply_join_transpose_rule::*;
147mod apply_to_join_rule;
148pub use apply_to_join_rule::*;
149mod distinct_agg_rule;
150pub use distinct_agg_rule::*;
151mod index_selection_rule;
152pub use index_selection_rule::*;
153mod push_calculation_of_join_rule;
154pub use push_calculation_of_join_rule::*;
155mod join_commute_rule;
156mod over_window_to_agg_and_join_rule;
157pub use over_window_to_agg_and_join_rule::*;
158mod over_window_split_rule;
159pub use over_window_split_rule::*;
160mod over_window_to_topn_rule;
161pub use join_commute_rule::*;
162pub use over_window_to_topn_rule::*;
163mod union_to_distinct_rule;
164pub use union_to_distinct_rule::*;
165mod agg_project_merge_rule;
166pub use agg_project_merge_rule::*;
167mod union_merge_rule;
168pub use union_merge_rule::*;
169mod dag_to_tree_rule;
170pub use dag_to_tree_rule::*;
171mod apply_share_eliminate_rule;
172pub use apply_share_eliminate_rule::*;
173mod top_n_on_index_rule;
174pub use top_n_on_index_rule::*;
175mod stream;
176pub use stream::bushy_tree_join_ordering_rule::*;
177pub use stream::filter_with_now_to_join_rule::*;
178pub use stream::generate_series_with_now_rule::*;
179pub use stream::separate_consecutive_join::*;
180pub use stream::split_now_and_rule::*;
181pub use stream::split_now_or_rule::*;
182pub use stream::stream_project_merge_rule::*;
183mod trivial_project_to_values_rule;
184pub use trivial_project_to_values_rule::*;
185mod union_input_values_merge_rule;
186pub use union_input_values_merge_rule::*;
187mod rewrite_like_expr_rule;
188pub use rewrite_like_expr_rule::*;
189mod min_max_on_index_rule;
190pub use min_max_on_index_rule::*;
191mod always_false_filter_rule;
192pub use always_false_filter_rule::*;
193mod join_project_transpose_rule;
194pub use join_project_transpose_rule::*;
195mod limit_push_down_rule;
196pub use limit_push_down_rule::*;
197mod pull_up_hop_rule;
198pub use pull_up_hop_rule::*;
199mod apply_offset_rewriter;
200use apply_offset_rewriter::ApplyOffsetRewriter;
201mod intersect_to_semi_join_rule;
202pub use intersect_to_semi_join_rule::*;
203mod except_to_anti_join_rule;
204pub use except_to_anti_join_rule::*;
205mod intersect_merge_rule;
206pub use intersect_merge_rule::*;
207mod except_merge_rule;
208pub use except_merge_rule::*;
209mod apply_union_transpose_rule;
210pub use apply_union_transpose_rule::*;
211mod apply_dedup_transpose_rule;
212pub use apply_dedup_transpose_rule::*;
213mod project_join_separate_rule;
214pub use project_join_separate_rule::*;
215mod grouping_sets_to_expand_rule;
216pub use grouping_sets_to_expand_rule::*;
217mod apply_project_set_transpose_rule;
218pub use apply_project_set_transpose_rule::*;
219mod cross_join_eliminate_rule;
220pub use cross_join_eliminate_rule::*;
221mod table_function_to_project_set_rule;
222
223pub use table_function_to_project_set_rule::*;
224mod apply_topn_transpose_rule;
225pub use apply_topn_transpose_rule::*;
226mod apply_limit_transpose_rule;
227pub use apply_limit_transpose_rule::*;
228mod batch;
229pub use batch::batch_project_merge_rule::*;
230mod common_sub_expr_extract_rule;
231pub use common_sub_expr_extract_rule::*;
232mod apply_over_window_transpose_rule;
233pub use apply_over_window_transpose_rule::*;
234mod apply_expand_transpose_rule;
235pub use apply_expand_transpose_rule::*;
236mod expand_to_project_rule;
237pub use expand_to_project_rule::*;
238mod agg_group_by_simplify_rule;
239pub use agg_group_by_simplify_rule::*;
240mod apply_hop_window_transpose_rule;
241pub use apply_hop_window_transpose_rule::*;
242mod agg_call_merge_rule;
243pub use agg_call_merge_rule::*;
244mod empty_agg_remove_rule;
245pub use empty_agg_remove_rule::*;
246mod add_logstore_rule;
247mod pull_up_correlated_predicate_agg_rule;
248mod source_to_iceberg_scan_rule;
249mod source_to_kafka_scan_rule;
250mod table_function_to_file_scan_rule;
251mod table_function_to_internal_backfill_progress;
252mod table_function_to_internal_source_backfill_progress;
253mod table_function_to_mysql_query_rule;
254mod table_function_to_postgres_query_rule;
255mod values_extract_project_rule;
256
257pub use add_logstore_rule::*;
258pub use batch::batch_iceberg_count_star::*;
259pub use batch::batch_iceberg_predicate_pushdown::*;
260pub use batch::batch_push_limit_to_scan_rule::*;
261pub use pull_up_correlated_predicate_agg_rule::*;
262pub use source_to_iceberg_scan_rule::*;
263pub use source_to_kafka_scan_rule::*;
264pub use table_function_to_file_scan_rule::*;
265pub use table_function_to_internal_backfill_progress::*;
266pub use table_function_to_internal_source_backfill_progress::*;
267pub use table_function_to_mysql_query_rule::*;
268pub use table_function_to_postgres_query_rule::*;
269pub use values_extract_project_rule::*;
270
271#[macro_export]
272macro_rules! for_all_rules {
273    ($macro:ident) => {
274        $macro! {
275              { ApplyAggTransposeRule }
276            , { ApplyFilterTransposeRule }
277            , { ApplyProjectTransposeRule }
278            , { ApplyProjectSetTransposeRule }
279            , { ApplyEliminateRule }
280            , { ApplyJoinTransposeRule }
281            , { ApplyShareEliminateRule }
282            , { ApplyToJoinRule }
283            , { MaxOneRowEliminateRule }
284            , { DistinctAggRule }
285            , { IndexDeltaJoinRule }
286            , { MergeMultiJoinRule }
287            , { ProjectEliminateRule }
288            , { ProjectJoinMergeRule }
289            , { ProjectMergeRule }
290            , { PullUpCorrelatedPredicateRule }
291            , { LeftDeepTreeJoinOrderingRule }
292            , { TranslateApplyRule }
293            , { PushCalculationOfJoinRule }
294            , { IndexSelectionRule }
295            , { OverWindowToTopNRule }
296            , { OverWindowToAggAndJoinRule }
297            , { OverWindowSplitRule }
298            , { OverWindowMergeRule }
299            , { JoinCommuteRule }
300            , { UnionToDistinctRule }
301            , { AggProjectMergeRule }
302            , { UnionMergeRule }
303            , { DagToTreeRule }
304            , { SplitNowAndRule }
305            , { SplitNowOrRule }
306            , { FilterWithNowToJoinRule }
307            , { GenerateSeriesWithNowRule }
308            , { TopNOnIndexRule }
309            , { TrivialProjectToValuesRule }
310            , { UnionInputValuesMergeRule }
311            , { RewriteLikeExprRule }
312            , { MinMaxOnIndexRule }
313            , { AlwaysFalseFilterRule }
314            , { BushyTreeJoinOrderingRule }
315            , { StreamProjectMergeRule }
316            , { SeparateConsecutiveJoinRule }
317            , { LogicalFilterExpressionSimplifyRule }
318            , { JoinProjectTransposeRule }
319            , { LimitPushDownRule }
320            , { PullUpHopRule }
321            , { IntersectToSemiJoinRule }
322            , { ExceptToAntiJoinRule }
323            , { IntersectMergeRule }
324            , { ExceptMergeRule }
325            , { ApplyUnionTransposeRule }
326            , { ApplyDedupTransposeRule }
327            , { ProjectJoinSeparateRule }
328            , { GroupingSetsToExpandRule }
329            , { CrossJoinEliminateRule }
330            , { ApplyTopNTransposeRule }
331            , { TableFunctionToProjectSetRule }
332            , { TableFunctionToFileScanRule }
333            , { TableFunctionToPostgresQueryRule }
334            , { TableFunctionToMySqlQueryRule }
335            , { TableFunctionToInternalBackfillProgressRule }
336            , { TableFunctionToInternalSourceBackfillProgressRule }
337            , { ApplyLimitTransposeRule }
338            , { CommonSubExprExtractRule }
339            , { BatchProjectMergeRule }
340            , { ApplyOverWindowTransposeRule }
341            , { ApplyExpandTransposeRule }
342            , { ExpandToProjectRule }
343            , { AggGroupBySimplifyRule }
344            , { ApplyHopWindowTransposeRule }
345            , { AggCallMergeRule }
346            , { ValuesExtractProjectRule }
347            , { BatchPushLimitToScanRule }
348            , { BatchIcebergPredicatePushDownRule }
349            , { BatchIcebergCountStar }
350            , { PullUpCorrelatedPredicateAggRule }
351            , { SourceToKafkaScanRule }
352            , { SourceToIcebergScanRule }
353            , { AddLogstoreRule }
354            , { EmptyAggRemoveRule }
355        }
356    };
357}
358
359macro_rules! impl_description {
360    ($( { $name:ident }),*) => {
361        paste::paste!{
362            $(impl Description for [<$name>] {
363                fn description(&self) -> &str {
364                    stringify!([<$name>])
365                }
366            })*
367        }
368    }
369}
370
371for_all_rules! {impl_description}
risingwave_frontend/optimizer/rule/mod.rs

risingwave_frontend/optimizer/rule/
mod.rs
