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