Skip to main content

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