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