query/optimizer.rs
1// Copyright 2023 Greptime Team
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
15pub mod constant_term;
16pub mod count_nest_aggr;
17pub mod count_wildcard;
18pub mod parallelize_scan;
19pub mod pass_distribution;
20pub mod remove_duplicate;
21pub mod scan_hint;
22pub mod string_normalization;
23#[cfg(test)]
24pub(crate) mod test_util;
25pub mod transcribe_atat;
26pub mod type_conversion;
27pub mod windowed_sort;
28
29use datafusion_common::Result;
30use datafusion_common::config::ConfigOptions;
31use datafusion_expr::LogicalPlan;
32
33use crate::QueryEngineContext;
34
35/// [`ExtensionAnalyzerRule`]s transform [`LogicalPlan`]s in some way to make
36/// the plan valid prior to the rest of the DataFusion optimization process.
37/// It's an extension of datafusion [`AnalyzerRule`]s but accepts [`QueryEngineContext`] as the second parameter.
38pub trait ExtensionAnalyzerRule {
39 /// Rewrite `plan`
40 fn analyze(
41 &self,
42 plan: LogicalPlan,
43 ctx: &QueryEngineContext,
44 config: &ConfigOptions,
45 ) -> Result<LogicalPlan>;
46}